-
Notifications
You must be signed in to change notification settings - Fork 121
Make Issue template more visually appealing. #51 #57
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
sanjay-kv
merged 4 commits into
recodehive:main
from
TonyStark-47:change-in-issue-templates
May 21, 2024
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
ee80650
Update and rename bug_report.md to bug_report.yml
TonyStark-47 e87c19c
Update and rename feature_request.md to feature_request.yml
TonyStark-47 c418248
Create documentation_update.yml
TonyStark-47 64a3e11
Merge branch 'Recode-Hive:main' into change-in-issue-templates
TonyStark-47 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Create documentation_update.yml
Made this 'documentation_update" template and added an issue form to make it easier for the contributor to raise it.
- Loading branch information
commit c418248efb7e8981f3eb2ae9e7aa65f5ee83add2
There are no files selected for viewing
61 changes: 61 additions & 0 deletions
.github/ISSUE_TEMPLATE/documentation_update.yml
This file contains hidden or 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,61 @@ | ||
| name: 📝 Documentation Update | ||
| description: Improve Documentation | ||
| title: "[Documentation Update]: " | ||
| body: | ||
| - type: checkboxes | ||
| id: existing-issue | ||
| attributes: | ||
| label: Is there an existing issue for this? | ||
| description: Please search to see if an issue already exists for the updates you want to make. | ||
| options: | ||
| - label: I have searched the existing issues | ||
| required: true | ||
| - type: textarea | ||
| id: issue-description | ||
| attributes: | ||
| label: Issue Description | ||
| description: Please provide a clear description of the documentation update you are suggesting. | ||
| placeholder: Describe the improvement or correction you'd like to see in the documentation. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: suggested-change | ||
| attributes: | ||
| label: Suggested Change | ||
| description: Provide details of the proposed change to the documentation. | ||
| placeholder: Explain how the documentation should be updated or corrected. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: rationale | ||
| attributes: | ||
| label: Rationale | ||
| description: Why is this documentation update necessary or beneficial? | ||
| placeholder: Explain the importance or reasoning behind the suggested change. | ||
| validations: | ||
| required: False | ||
| - type: dropdown | ||
| id: urgency | ||
| attributes: | ||
| label: Urgency | ||
| description: How urgently do you believe this documentation update is needed? | ||
| options: | ||
| - High | ||
| - Medium | ||
| - Low | ||
| default: 0 | ||
| validations: | ||
| required: true | ||
| - type: checkboxes | ||
| id: terms | ||
| attributes: | ||
| label: Record | ||
| options: | ||
| - label: "I agree to follow this project's Code of Conduct" | ||
| required: true | ||
| - label: "I'm a GSSOC contributor" | ||
| required: False | ||
| - label: "I want to work on this issue" | ||
| required: False | ||
| - label: "I'm willing to provide further clarification or assistance if needed." | ||
| required: False |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.