This is an automated email from the ASF dual-hosted git repository.
rawkintrevo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/mahout.git
The following commit(s) were added to refs/heads/main by this push:
new 6da675666 Issue and Pull request templates (#502)
6da675666 is described below
commit 6da675666010a84ac809bef11f74da96ccfaad4d
Author: Vedansh Saini <[email protected]>
AuthorDate: Tue Mar 4 04:01:26 2025 +0530
Issue and Pull request templates (#502)
* uncommented
* minor changes
* pr template
---
.github/ISSUE_TEMPLATE/bug_report.md | 31 +++++++++++++++
.github/ISSUE_TEMPLATE/documentation_issue.md | 19 +++++++++
.github/ISSUE_TEMPLATE/feature_request.md | 22 +++++++++++
.github/ISSUE_TEMPLATE/issue_template.md | 24 +++++------
.github/PULL_REQUEST_TEMPLATE | 57 ++++++++++++++++++---------
5 files changed, 123 insertions(+), 30 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md
b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 000000000..8972690c7
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -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.
diff --git a/.github/ISSUE_TEMPLATE/documentation_issue.md
b/.github/ISSUE_TEMPLATE/documentation_issue.md
new file mode 100644
index 000000000..a5fbcc109
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/documentation_issue.md
@@ -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.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md
b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 000000000..dc0edf595
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -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.
diff --git a/.github/ISSUE_TEMPLATE/issue_template.md
b/.github/ISSUE_TEMPLATE/issue_template.md
index 1661c80a1..16909ae1e 100644
--- a/.github/ISSUE_TEMPLATE/issue_template.md
+++ b/.github/ISSUE_TEMPLATE/issue_template.md
@@ -1,30 +1,30 @@
## Issue Title
-<!-- Provide a clear and concise title for the issue -->
+Provide a clear and concise title for the issue
### Description
-<!-- Describe the issue in detail. Include what the current behavior is and
provide any relevant examples or screenshots. -->
+Describe the issue in detail. Include what the current behavior is and provide
any relevant examples or screenshots.
### Steps to Reproduce
-1. <!-- First step -->
-2. <!-- Second step -->
-3. <!-- Third step -->
+1. First step
+2. Second step
+3. Third step
### Expected Behavior
-<!-- What do you expect to happen? -->
+What do you expect to happen?
### Actual Behavior
-<!-- What actually happens? Include any error messages or logs if applicable.
-->
+What actually happens? Include any error messages or logs if applicable.
### Environment
-- **OS:** <!-- e.g. Windows, MacOS, Linux -->
-- **Browser:** <!-- e.g. Chrome, Firefox, Safari -->
-- **Version:** <!-- e.g. 1.0.0 -->
+- **OS:** e.g. Windows, MacOS, Linux
+- **Browser:** e.g. Chrome, Firefox, Safari
+- **Version:** e.g. 1.0.0
### Suggested Fix
-<!-- If you have an idea for a fix, please provide details here. -->
+If you have an idea for a fix, please provide details here.
### Additional Context
-<!-- Add any other context about the problem here. For example, links to
related issues or discussions. -->
+Add any other context about the problem here. For example, links to related
issues or discussions.
### Checklist
- [ ] I have searched the existing issues for duplicates.
diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE
index 1003c2d66..f06d43cb4 100644
--- a/.github/PULL_REQUEST_TEMPLATE
+++ b/.github/PULL_REQUEST_TEMPLATE
@@ -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
