nmfs-ost / nmfs-ost/asar

[chore] update feature issues template

Open
#469 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

chore NSAP-code-cleanup
Dominant language
R
Stars
44
Forks
10
Avg merge
1d 19h
Merged PRs (30d)
18

Description

I think it would be nice to update the feature issues template to either have the option to check what topic the issue falls in according to our versioning conventions. This could link to the contributor guide(https://github.com/nmfs-ost/asar/blob/main/CONTRIBUTING.md) which could contain our semantic versioning rules once that is finalized.

Alternatively, we could have issue templates for each choice -- grouped based on how they increment versioning (major, minor, or patch)

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 with .github/ISSUE_TEMPLATE/feature_request.yml and CONTRIBUTING.md. Confirm the project's semantic-versioning rules and choose whether the feature template should add topic choices or be split into major, minor, and patch templates. Done means the selected template approach is implemented and the contributor guide links to the finalized rules.

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
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.