diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..99fd321 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,28 @@ + name: "🐞 Bug Report" + description: "Create a report to help us improve" + title: "BUG:Add suitable title here" + labels: ["Bug"] + body: + - type: checkboxes + attributes: + label: "Is there an existing issue for this?" + description: "Please search to see if an issue already exists for the bug you encountered." + options: + - label: "I have searched the existing issues" + required: true + - type: textarea + attributes: + label: "What happened?" + description: "A concise description of what you're experiencing." + validations: + required: true + - type: checkboxes + attributes: + label: "Record" + options: + - label: "I agree to follow this project's Code of Conduct" + required: true + - label: I have checked the existing [issues](https://github.com/Data-Sculptor-X/VOJ-ReactJS/issues) + required: true + - label: "I'm a GSSOC'24-Extended contributor" + - label: "I want to work on this issue" \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 0000000..a8f17ac --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,28 @@ +name: "📑 Documentation Update" +description: "Improve Documentation" +title: "DOC:Add suitable title here" +labels: [DOC] +body: + - type: textarea + attributes: + label: "What's wrong with the existing documentation" + description: "Which things do we need to add or delete" + validations: + required: true + - type: textarea + attributes: + label: "Add ScreenShots" + description: "Add sufficient SS to explain your issue." + validations: + required: false + + - type: checkboxes + attributes: + label: "Record" + options: + - label: "I agree to follow this project's Code of Conduct" + required: true + - label: I have checked the existing [issues](https://github.com/Data-Sculptor-X/VOJ-ReactJS/issues) + required: true + - label: "I'm a GSSOC'24-Extended contributor" + - label: "I want to work on this issue" \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..dbc3426 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,27 @@ +name: "✨ Feature Request" +description: "Suggest an idea for this project " +title: "Feat:Add suitable title here" +labels: [Enhancement] +body: + - type: textarea + attributes: + label: "Describe the feature" + description: + validations: + required: true + - type: textarea + attributes: + label: "Add ScreenShots" + description: "Add sufficient SS to explain your issue." + validations: + required: true + - type: checkboxes + attributes: + label: "Record" + options: + - label: "I agree to follow this project's Code of Conduct" + required: true + - label: I have checked the existing [issues](https://github.com/Data-Sculptor-X/VOJ-ReactJS/issues) + required: true + - label: "I'm a GSSOC'24-Extended contributor" + - label: "I want to work on this issue" \ No newline at end of file diff --git a/.github/Pull_Request_Template.md b/.github/Pull_Request_Template.md new file mode 100644 index 0000000..e122029 --- /dev/null +++ b/.github/Pull_Request_Template.md @@ -0,0 +1,38 @@ +### Description +A clear and concise description of what the PR does. +- This PR does the following: + - Adds ... + - Fixes ... + - Updates ... + +### Related Issues +Link any related issues using the format `Fixes #issue_number`. +This helps to automatically close related issues when the PR is merged. +- Placeholder: "Fixes #123" + +### Changes +List the detailed changes made in this PR. +- Added a new feature to ... +- Refactored the ... +- Fixed a bug in ... + +### Testing Instructions +Detailed instructions on how to test the changes. Include any setup needed and specific test cases. +1. Pull this branch. +2. Run `npm install` to install dependencies. +3. Run `npm test` to execute the test suite. +4. Verify that ... + +### Screenshots (if applicable) +Add any screenshots that help explain or visualize the changes. + +### Additional Context +Any additional context or information that reviewers should be aware of. +- This PR is based on the following... + +### Checklist +Make sure to check off all the items before submitting. Mark with [x] if done. +- [ ] I have performed a self-review of my code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] My changes generate no new warnings +- [ ] I am working on this issue under GSSOC-Extended