NeonGeckoCom / NeonGeckoCom/neon-docs

[FEAT] Documentation-specific Issue templates

Open
#56 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
No language data
Stars
5
Forks
9
PR merge metrics
No merged PRs in 30d

Description

Objective

Update the issue templates to be more documentation-oriented.

Initial Implementation Requirements
  • "BUG" template should ask for a link to the page and specific section that is incorrect
  • "FEAT" template should be dropped
  • "DOC" template should be added for new documentation that is needed with a template prompting for:
    • current page or section to be updated
    • existing documentation to add (if applicable, i.e. a README file)
Other Considerations

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the repository's existing issue templates and compare their current prompts with the requirements in this issue. Done means the BUG template requests an incorrect page and section, the FEAT template is removed, and a DOC template prompts for the page or section and any existing documentation to update.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.