diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..87002141 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,31 @@ +--- +name: "Bug Report" +about: "Create a report to help us improve" +title: "[Bug] " +labels: bug +assignees: '' +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Environment (please complete the following information):** +- OS: [e.g. Ubuntu 22.04] +- Python version: [e.g. 3.11] +- ZenML version: [e.g. 0.56.0] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..c7ec776d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Ask a question + url: https://zenml.io/slack-invite/ + about: Please ask and answer questions here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..f0b0542e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: "Feature Request" +about: "Suggest an idea for this project" +title: "[Feature] " +labels: enhancement +assignees: '' +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex: I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..2ab89bcf --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,11 @@ +# Summary + +Please provide a short summary explaining the motivation behind these changes. + +# Checklist +- [ ] I have read the [contributing guidelines](CONTRIBUTING.md). +- [ ] I have run the necessary tests and linters. +- [ ] I have updated relevant documentation where applicable. + +# Related Issues +Please link to any relevant issues or discussions. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 94b88803..326f80a0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -58,8 +58,8 @@ to ZenML dashboard. Issues should be used to report problems with the library, request a new feature, or to discuss potential changes before -a PR is created. When you create a new Issue, a template will be loaded that -will guide you through collecting and +a PR is created. When you create a new issue, please use one of the provided +templates. These templates will guide you through collecting and providing the information we need to investigate. If you find an Issue that addresses your problem, please add your own @@ -81,8 +81,9 @@ general, PRs should: suite already exists). - Address a single concern in the least number of changed lines as possible. - Include documentation in the repo or in your Pull Request. -- Be accompanied by a filled-out Pull Request template (loaded automatically when - a PR is created). +- Be accompanied by a filled-out pull request template (loaded automatically + when a PR is created). This helps reviewers understand the motivation and + context for your changes. For changes that address core functionality or would require breaking changes, it's best to open an Issue to discuss your proposal first. This is not required but can save time