nhcarrigan/docs
9
0
Fork 0
generated from nhcarrigan/template
Code Issues 2 Pull Requests 6 Actions Releases 1 Activity

[OTHER] - Audit Contributing Documentation #9

New Issue
Open
opened 2025-07-06 18:04:31 -07:00 by naomi · 1 comment
naomi commented 2025-07-06 18:04:31 -07:00
Owner
Copy Link
Copy Source

Attestations

  • I have read and agree to the Code of Conduct
  • I have read and agree to the Community Guidelines.
  • I have confirmed that the issue I am opening is unique, and has not already been reported (whether closed or not).
  • I have reviewed the Security Policy and have determined that this is not a security vulnerability.
  • This is not a feature request or bug report that I am mis-filing to avoid the issue template.

Share your thoughts:

We should make sure our contributing documentation are updated to accurately reflect:

  • Contributions are only available to team members
    • Folks can apply to join the team
  • Issues go through Discord first, our team triages and tickets
  • Team members have maintain access on repositories, and can push to non-default branches
    • Branches should be prefixed with name, then type, e.g. naomi/feat/rewrite-docs
  • PRs must be made, Naomi to review
### Attestations - [x] I have read and agree to the [Code of Conduct](https://docs.nhcarrigan.com/community/coc/) - [x] I have read and agree to the [Community Guidelines](https://docs.nhcarrigan.com/community/guide/). - [x] I have confirmed that the issue I am opening is unique, and has not already been reported (whether closed or not). - [x] I have reviewed the [Security Policy](https://docs.nhcarrigan.com/legal/security/) and have determined that this is not a security vulnerability. - [x] This is not a feature request or bug report that I am mis-filing to avoid the issue template. ### Share your thoughts: We should make sure our contributing documentation are updated to accurately reflect: - Contributions are only available to team members - Folks can apply to join the team - Issues go through Discord first, our team triages and tickets - Team members have maintain access on repositories, and can push to non-default branches - Branches should be prefixed with name, then type, e.g. `naomi/feat/rewrite-docs` - PRs must be made, Naomi to review
naomi added this to the Staff Tickets project 2025-12-17 17:33:31 -08:00
naomi added the
points
8
time
4-5 days
 labels 2025-12-17 17:34:49 -08:00
naomi removed this from the Staff Tickets project 2025-12-17 17:41:16 -08:00
naomi added
status
blocked
 and removed
status
ready for dev
 labels 2025-12-17 17:41:27 -08:00
naomi commented 2025-12-17 17:42:51 -08:00
Author
Owner
Copy Link
Copy Source

Blocking this until I've completed the current docs work in #20

Blocking this until I've completed the current docs work in #20
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
aspect
code
Concerns the software code in the repository
aspect
dx
Concerns developers' experience with the codebase
aspect
interface
Concerns end-users' experience with the software
aspect
text
Concerns the documentation material in the repository
contribute
good first issue
A great opportunity for a team member to learn a new codebase
contribute
help wanted
Open for anyone on our team to grab.
contribute
staff only
Restricted to our executive leadership.
goal
addition
Addition of new feature
goal
fix
Bug fix
goal
improvement
Improvement to an existing feature
points
1
Very simple issue requiring minimal effort and complexity.
points
13
Extremely complex issue representing major undertakings. Should be broken down into smaller pieces.
points
2
Simple issue that requires a bit more thought or investigation.
points
3
Moderate complexity issue requiring more substantial work.
points
5
Complex issue requiring significant effort and expertise.
points
8
Very complex issue requiring extensive work and deep expertise.
priority
critical
1
Must be fixed ASAP
priority
high
2
Stalls work on the project or its dependents
priority
low
4
Low priority and doesn't need to be rushed
priority
medium
3
Not blocking but should be fixed soon
priority
none
5
No priority, should only be performed when a developer is available
status
awaiting triage
Has not been triaged & therefore, not ready for work
status
blocked
Blocked and therefore not ready for work
status
discarded
Will not be worked on
status
discontinued
Not suitable for work as repo is in maintenance
status
label work required
Needs proper labelling before it can be worked on
status
ready for dev
Ready for work
status
ticket work required
Needs more details before it can be worked on
talk
discussion
Open for discussions and feedback
talk
question
Can be resolved with an answer
time
1 day
Approximately one full day of development work.
time
1-2 weeks
One to two weeks of focused development effort.
time
2-3 days
Two to three days of development effort.
time
4-5 days
Approximately one week of development work.
time
<1 day
Less than one day of focused work. Quick fixes or simple tasks.
time
>2 weeks
More than two weeks of development work. Must be broken down into smaller pieces.
No Label
aspect
text
contribute
help wanted
goal
improvement
points
8
priority
medium
3
status
blocked
time
4-5 days
Milestone
No items
No Milestone
Assignees
Clear assignees
gurkirat hanna (Hanna Rose) hikari (Hikari) minori (Minori) naomi (Naomi Carrigan) rain teklu tim
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: nhcarrigan/docs#9
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?