From f70004088fbb2f67bd6c9bf744f58d87cad6b02c Mon Sep 17 00:00:00 2001 From: Vedansh Saini <77830698+vedansh-5@users.noreply.github.com> Date: Tue, 4 Mar 2025 00:36:50 +0530 Subject: [PATCH 1/3] uncommented --- .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(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/documentation_issue.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..5b072cd0e8 --- /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 + + +### Steps to Reproduce + + + + +### 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 0000000000..a5fbcc109a --- /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 0000000000..dc0edf5958 --- /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 1661c80a1e..16909ae1e8 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 ### Description - +Describe the issue in detail. Include what the current behavior is and provide any relevant examples or screenshots. ### Steps to Reproduce -1. -2. -3. +1. First step +2. Second step +3. Third step ### Expected Behavior - +What do you expect to happen? ### Actual Behavior - +What actually happens? Include any error messages or logs if applicable. ### Environment -- **OS:** -- **Browser:** -- **Version:** +- **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. ### Additional Context - +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 1003c2d666..79367fc577 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. +- Fixes MAHOUT-XXXX +- 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 From f2a8d21be4bfa38a6ebda39f0f3b123a80bb0a16 Mon Sep 17 00:00:00 2001 From: Vedansh Saini <77830698+vedansh-5@users.noreply.github.com> Date: Tue, 4 Mar 2025 03:42:00 +0530 Subject: [PATCH 2/3] minor changes --- .github/ISSUE_TEMPLATE/bug_report.md | 8 ++++---- .github/PULL_REQUEST_TEMPLATE | 6 ++---- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 5b072cd0e8..8972690c7c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,12 +7,12 @@ 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? diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index 79367fc577..311bdd252b 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -1,10 +1,8 @@ ### Purpose of PR Describe what this PR does. -### Linked Issues -Add links to related issues. -- Fixes MAHOUT-XXXX -- Related to #123 + +Closes #123 ### Changes Made - [ ] Bug fix From f19a92abadbae92da990c0d87f1ef1fb72d37498 Mon Sep 17 00:00:00 2001 From: Vedansh Saini <77830698+vedansh-5@users.noreply.github.com> Date: Tue, 4 Mar 2025 03:58:22 +0530 Subject: [PATCH 3/3] pr template --- .github/PULL_REQUEST_TEMPLATE | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index 311bdd252b..f06d43cb4c 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -1,8 +1,10 @@ ### Purpose of PR Describe what this PR does. - -Closes #123 +### Linked Issues +Add links to related issues. +- Closes #123 +- Related to #123 ### Changes Made - [ ] Bug fix