Skip to content

Commit cf94824

Browse files
authored
Add contribution templates and update guidelines (#209)
1 parent 1ece965 commit cf94824

File tree

5 files changed

+71
-4
lines changed

5 files changed

+71
-4
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: "Bug Report"
3+
about: "Create a report to help us improve"
4+
title: "[Bug] "
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
**Describe the bug**
10+
A clear and concise description of what the bug is.
11+
12+
**To Reproduce**
13+
Steps to reproduce the behavior:
14+
1. Go to '...'
15+
2. Click on '....'
16+
3. Scroll down to '....'
17+
4. See error
18+
19+
**Expected behavior**
20+
A clear and concise description of what you expected to happen.
21+
22+
**Screenshots**
23+
If applicable, add screenshots to help explain your problem.
24+
25+
**Environment (please complete the following information):**
26+
- OS: [e.g. Ubuntu 22.04]
27+
- Python version: [e.g. 3.11]
28+
- ZenML version: [e.g. 0.56.0]
29+
30+
**Additional context**
31+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Ask a question
4+
url: https://zenml.io/slack-invite/
5+
about: Please ask and answer questions here.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: "Feature Request"
3+
about: "Suggest an idea for this project"
4+
title: "[Feature] "
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex: I'm always frustrated when [...]
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Additional context**
19+
Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Summary
2+
3+
Please provide a short summary explaining the motivation behind these changes.
4+
5+
# Checklist
6+
- [ ] I have read the [contributing guidelines](CONTRIBUTING.md).
7+
- [ ] I have run the necessary tests and linters.
8+
- [ ] I have updated relevant documentation where applicable.
9+
10+
# Related Issues
11+
Please link to any relevant issues or discussions.

CONTRIBUTING.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ to ZenML dashboard.
5858

5959
Issues should be used to report problems with the library, request a new
6060
feature, or to discuss potential changes before
61-
a PR is created. When you create a new Issue, a template will be loaded that
62-
will guide you through collecting and
61+
a PR is created. When you create a new issue, please use one of the provided
62+
templates. These templates will guide you through collecting and
6363
providing the information we need to investigate.
6464

6565
If you find an Issue that addresses your problem, please add your own
@@ -81,8 +81,9 @@ general, PRs should:
8181
suite already exists).
8282
- Address a single concern in the least number of changed lines as possible.
8383
- Include documentation in the repo or in your Pull Request.
84-
- Be accompanied by a filled-out Pull Request template (loaded automatically when
85-
a PR is created).
84+
- Be accompanied by a filled-out pull request template (loaded automatically
85+
when a PR is created). This helps reviewers understand the motivation and
86+
context for your changes.
8687

8788
For changes that address core functionality or would require breaking changes, it's best to open
8889
an Issue to discuss your proposal first. This is not required but can save time

0 commit comments

Comments
 (0)