-
Notifications
You must be signed in to change notification settings - Fork 951
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Issue and Pull request templates (#502)
* uncommented * minor changes * pr template
- Loading branch information
Showing
5 changed files
with
123 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
name: "Bug Report" | ||
about: "Report a bug to help us improve" | ||
title: "[Bug] " | ||
labels: ["bug"] | ||
assignees: [] | ||
--- | ||
|
||
### Description | ||
A clear and concise description of the bug. | ||
|
||
### Steps to Reproduce | ||
1. Step 1 | ||
2. Step 2 | ||
3. Step 3 | ||
|
||
### Expected Behavior | ||
What should have happened? | ||
|
||
### Actual Behavior | ||
What actually happened? | ||
|
||
### Screenshots or Logs | ||
Add screenshots or log output if applicable. | ||
|
||
### Environment | ||
- **OS:** e.g., Windows, Linux | ||
- **Browser/Tool Version:** e.g., Chrome 96, Python 3.8 | ||
|
||
### Additional Context | ||
Any other information that may be helpful. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
name: "Documentation Issue" | ||
about: "Report issues related to documentation" | ||
title: "[Docs] " | ||
labels: ["documentation"] | ||
assignees: [] | ||
--- | ||
|
||
### Description | ||
What is unclear, incorrect, or missing? | ||
|
||
### Location of the Issue | ||
Provide links or file paths where the issue exists. | ||
|
||
### Suggested Improvement | ||
How should this be fixed? | ||
|
||
### Additional Context | ||
Anything else that would help improve the documentation. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
name: "Feature Request" | ||
about: "Suggest a new feature" | ||
title: "[Feature] " | ||
labels: ["enhancement"] | ||
assignees: [] | ||
--- | ||
|
||
### Summary | ||
A brief description of the feature. | ||
|
||
### Use Case | ||
Explain why this feature is useful. | ||
|
||
### Proposed Implementation | ||
How do you propose implementing this feature? | ||
|
||
### Alternatives Considered | ||
Have you thought of other ways to solve the same problem? | ||
|
||
### Additional Context | ||
Any other relevant information or resources. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,42 @@ | ||
### Purpose of PR: | ||
Please give a short description of what this PR is for. | ||
### Purpose of PR | ||
Describe what this PR does. | ||
|
||
### Linked Issues | ||
Add links to related issues. | ||
- Closes #123 | ||
- Related to #123 | ||
|
||
### Changes Made | ||
- [ ] Bug fix | ||
- [ ] New feature | ||
- [ ] Documentation update | ||
|
||
### Important ToDos | ||
Please mark each with an "x" | ||
- [ ] A JIRA ticket exists (if not, please create this first)[https://issues.apache.org/jira/browse/mahout/] | ||
- [ ] Title of PR is "MAHOUT-XXXX Brief Description of Changes" where XXXX is the JIRA number. | ||
- [ ] Created unit tests where appropriate | ||
- [ ] Added licenses correct on newly added files | ||
- [ ] Assigned JIRA to self | ||
- [ ] Added documentation in scala docs/java docs, and to website | ||
- [ ] Successfully built and ran all unit tests, verified that all tests pass locally. | ||
|
||
If all of these things aren't complete, but you still feel it is | ||
appropriate to open a PR, please add [WIP] after MAHOUT-XXXX before the | ||
descriptions- e.g. "MAHOUT-XXXX [WIP] Description of Change" | ||
|
||
Does this change break earlier versions? | ||
|
||
Is this the beginning of a larger project for which a feature branch should be made? | ||
Please mark each with an "x" | ||
|
||
A GitHub issue exists (if not, please create one) [https://github.com/apache/mahout/issues] | ||
- [ ] Title of PR is "Issue #XXXX: Brief Description of Changes" where XXXX is the GitHub issue number. | ||
- [ ] Created unit tests where appropriate | ||
- [ ] Added correct licenses on newly added files | ||
- [ ] Assigned GitHub issue to self | ||
- [ ] Added documentation in ScalaDocs/JavaDocs and to the website | ||
- [ ] Successfully built and ran all unit tests, verified that all tests pass locally | ||
|
||
If all of these items are not yet complete, but you still feel it is appropriate to open a PR, please open it as a **Draft PR** instead. | ||
Once all requirements are met, you can mark it as ready for review. | ||
|
||
|
||
### Breaking Changes | ||
Does this PR introduce a breaking change? | ||
- [ ] Yes | ||
- [ ] No | ||
|
||
### Testing & Verification | ||
Describe how you tested the changes. | ||
- [ ] Unit tests added | ||
- [ ] Manually tested | ||
|
||
### Checklist | ||
- [ ] The title follows the format "MAHOUT-XXXX Brief Description" | ||
- [ ] GitHub issue is created | ||
- [ ] Code follows ASF guidelines |