Skip to content

Commit

Permalink
feat: update documentation request and bug templates (#2305)
Browse files Browse the repository at this point in the history
* feat: enhance bug & doc request issue templates

* feat: enhance bug & doc request issue templates

* remove meta and new-task

* fix: update support link

* nit: line return

* nit: undo
  • Loading branch information
thisisjoshford authored Nov 14, 2024
1 parent 496c007 commit 40643cb
Show file tree
Hide file tree
Showing 6 changed files with 172 additions and 61 deletions.
22 changes: 0 additions & 22 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Question
url: https://stackoverflow.com/questions/tagged/nearprotocol
about: Please ask and answer questions here.
- name: Need help?
url: https://t.me/neardev
about: Get technical support from our developer community on Telegram.
97 changes: 97 additions & 0 deletions .github/ISSUE_TEMPLATE/doc-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
name: 🐞 Report a Documentation Error
description: Report errors or unclear content in the documentation
title: "[BUG] "
labels: ["documentation", "bug"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to help us improve our documentation! 🙏
- type: textarea
id: description
attributes:
label: Description
placeholder: The documentation is incorrect/unclear/missing information about...
validations:
required: true

- type: input
id: page-url
attributes:
label: Page URL
placeholder: https://docs.near.org/<path>
validations:
required: true

- type: input
id: section
attributes:
label: Section/Heading
placeholder: "e.g., Installation Guide > Prerequisites"
validations:
required: false

- type: textarea
id: current-text
attributes:
label: Current Text
description: If applicable, paste the current problematic text here
placeholder: Paste the current text that needs to be corrected...
validations:
required: false

- type: checkboxes
id: impact
attributes:
label: Impact
description: How does this documentation issue affect users?
options:
- label: Incorrect information
- label: Missing information
- label: Unclear explanation
- label: Broken link
- label: Code example doesn't work
- label: Other (please specify in description)
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected Information
placeholder: The documentation should explain...
validations:
required: true

- type: textarea
id: suggested-fix
attributes:
label: Suggested Fix
placeholder: I suggest changing/adding...
validations:
required: false

- type: dropdown
id: browsers
attributes:
label: Browser
description: If this is a layout/rendering issue, what browsers are you seeing the problem on?
multiple: true
options:
- Chrome
- Firefox
- Safari
- Microsoft Edge
- Other
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context about the problem here, including screenshots if applicable
validations:
required: false
72 changes: 72 additions & 0 deletions .github/ISSUE_TEMPLATE/doc-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
name: 📝 Documentation Request
description: Request new documentation or updates to existing docs
title: "[DOC] "
labels: ["documentation"]
body:
- type: markdown
attributes:
value: "## 📝 Documentation Request"

- type: dropdown
id: doc_type
attributes:
label: "Documentation Type"
options:
- "New Documentation"
- "Update Existing Documentation"
validations:
required: true

- type: textarea
id: what
attributes:
label: "What needs documentation?"
placeholder: "Describe what needs to be documented or updated. For existing docs, please provide links."
validations:
required: true

- type: textarea
id: why
attributes:
label: "Why is this documentation needed?"
placeholder: "What problems will this documentation solve? Who will benefit from it?"
validations:
required: true

- type: textarea
id: done
attributes:
label: "Documentation Requirements"
placeholder: "What should the documentation include? (e.g., code examples, diagrams, step-by-step guides)"
validations:
required: true

- type: textarea
id: additional
attributes:
label: "Resources & References"
placeholder: "Any relevant resources, existing documentation, code references, or screenshots?"

- type: dropdown
id: priority
attributes:
label: "Priority"
options:
- "🔴 P0 : Missing Critical Documentation"
- "🟠 P1 : Important Documentation Gap"
- "🟡 P2 : Documentation Enhancement"
- "🟢 P3 : Nice to Have"
- "⚪ P4 : Minor Update"
validations:
required: true

- type: markdown
attributes:
value: |
| Priority | Name | Description |
|----------|------|-------------|
| 🔴 P0 | CRITICAL | Missing documentation blocking team progress |
| 🟠 P1 | HIGH | Important documentation gap affecting productivity |
| 🟡 P2 | MEDIUM | Significant documentation enhancement |
| 🟢 P3 | NORMAL | Helpful documentation addition |
| ⚪ P4 | LOW | Minor documentation update |
19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/documentation-request.md

This file was deleted.

17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/meta-improvement.md

This file was deleted.

0 comments on commit 40643cb

Please sign in to comment.