|
| 1 | +name: 📝 Documentation Update |
| 2 | +description: Improve Documentation |
| 3 | +title: "[Documentation Update]: " |
| 4 | +labels: 'enhancement' |
| 5 | +body: |
| 6 | + - type: checkboxes |
| 7 | + id: existing-issue |
| 8 | + attributes: |
| 9 | + label: Is there an existing issue for this? |
| 10 | + description: Please search to see if an issue already exists for the updates you want to make. |
| 11 | + options: |
| 12 | + - label: I have searched the existing issues |
| 13 | + required: true |
| 14 | + |
| 15 | + - type: textarea |
| 16 | + id: issue-description |
| 17 | + attributes: |
| 18 | + label: Issue Description |
| 19 | + description: Please provide a clear description of the documentation update you are suggesting. |
| 20 | + placeholder: Describe the improvement or correction you'd like to see in the documentation. |
| 21 | + validations: |
| 22 | + required: true |
| 23 | + |
| 24 | + - type: textarea |
| 25 | + id: suggested-change |
| 26 | + attributes: |
| 27 | + label: Suggested Change |
| 28 | + description: Provide details of the proposed change to the documentation. |
| 29 | + placeholder: Explain how the documentation should be updated or corrected. |
| 30 | + validations: |
| 31 | + required: true |
| 32 | + |
| 33 | + - type: textarea |
| 34 | + id: rationale |
| 35 | + attributes: |
| 36 | + label: Rationale |
| 37 | + description: Why is this documentation update necessary or beneficial? |
| 38 | + placeholder: Explain the importance or reasoning behind the suggested change. |
| 39 | + validations: |
| 40 | + required: false |
| 41 | + |
| 42 | + - type: dropdown |
| 43 | + id: urgency |
| 44 | + attributes: |
| 45 | + label: Urgency |
| 46 | + description: How urgently do you believe this documentation update is needed? |
| 47 | + options: |
| 48 | + - High |
| 49 | + - Medium |
| 50 | + - Low |
| 51 | + default: 0 |
| 52 | + validations: |
| 53 | + required: true |
| 54 | + |
| 55 | + - type: checkboxes |
| 56 | + id: terms |
| 57 | + attributes: |
| 58 | + label: Acknowledgements |
| 59 | + description: Ensure you have read and agree to the project's guidelines. |
| 60 | + options: |
| 61 | + - label: I have read the Contributing Guidelines |
| 62 | + required: true |
| 63 | + - label: I'm a GSSOC'24 contributor |
| 64 | + required: false |
| 65 | + - label: I have starred the repository |
| 66 | + required: true |
| 67 | + - label: I have read and followed the Contribution Guidelines |
| 68 | + required: true |
| 69 | + - label: I have followed the code style guidelines of this project |
| 70 | + required: true |
| 71 | + - label: I have checked for any existing open issues that my pull request may address |
| 72 | + required: true |
| 73 | + - label: I have ensured that my changes do not break any existing functionality |
| 74 | + required: true |
| 75 | + - label: Each contributor is allowed to create a maximum of 4 issues per day. This helps us manage and address issues efficiently |
| 76 | + required: true |
| 77 | + - label: I have read the resources for guidance listed below |
| 78 | + required: true |
| 79 | + - label: I have not used AI-generated content (e.g., ChatGPT, other AI tools) |
| 80 | + required: true |
| 81 | + - label: I have not used content from existing sites (e.g., text, images) |
| 82 | + required: true |
| 83 | + - label: I have followed all security rules and only shared trusted resources |
| 84 | + required: true |
0 commit comments