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

chore: audit contributing docs #11

Closed
nerdychara wants to merge 2 commits from chore/audit-contributing-docs into main
pull from: chore/audit-contributing-docs
merge into: nhcarrigan:main
Conversation 4 Commits 2 Files Changed 1
+35 -68
nerdychara commented 2025-09-18 17:41:19 -07:00
Member
Copy Link
Copy Source

Explanation

Naomi is not using Codeberg anymore.

Issue

9

Attestations

Dependencies

  • I have pinned the dependencies to a specific patch version.

Style

  • I have run the linter and resolved any errors.
  • My pull request uses an appropriate title, matching the conventional commit standards.
  • My scope of feat/fix/chore/etc. correctly matches the nature of changes in my pull request.

Tests

  • My contribution adds new code, and I have added tests to cover it.
  • My contribution modifies existing code, and I have updated the tests to reflect these changes.
  • All new and existing tests pass locally with my changes.
  • Code coverage remains at or above the configured threshold.

Documentation

No response

Versioning

Patch - My pull request introduces bug fixes ONLY.

### Explanation Naomi is not using Codeberg anymore. ### Issue 9 ### 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/). - [ ] My contribution complies with the [Contributor Covenant](https://docs.nhcarrigan.com/dev/covenant/). ### Dependencies - [x] I have pinned the dependencies to a specific patch version. ### Style - [x] I have run the linter and resolved any errors. - [x] My pull request uses an appropriate title, matching the conventional commit standards. - [x] My scope of feat/fix/chore/etc. correctly matches the nature of changes in my pull request. ### Tests - [x] My contribution adds new code, and I have added tests to cover it. - [x] My contribution modifies existing code, and I have updated the tests to reflect these changes. - [x] All new and existing tests pass locally with my changes. - [x] Code coverage remains at or above the configured threshold. ### Documentation _No response_ ### Versioning Patch - My pull request introduces bug fixes ONLY.
naomi reviewed 2025-09-18 17:54:14 -07:00
src/content/docs/dev/contributing.md Outdated
@@ -106,3 +105,3 @@
1. Go to your forked repository on Codeberg.
1. Go to repository on NHCarrigan's Git instance.
2. Click the "Code" button and copy the URL (HTTPS or SSH, depending on your setup).
naomi commented 2025-09-18 17:54:14 -07:00
Owner
Copy Link
Copy Source

We only support HTTPS, i havent bothered to set up the SSH passthrough for Docker.

We only support HTTPS, i havent bothered to set up the SSH passthrough for Docker.
nerdychara marked this conversation as resolved
naomi reviewed 2025-09-18 17:55:10 -07:00
src/content/docs/dev/contributing.md Outdated
@@ -255,3 +254,2 @@
```bash
git fetch upstream
git merge upstream/main
git fetch
naomi commented 2025-09-18 17:55:10 -07:00
Owner
Copy Link
Copy Source

Should be git checkout main, git pull

No need for fetching because we dont do forks.

Should be git checkout main, git pull No need for fetching because we dont do forks.
nerdychara marked this conversation as resolved
nerdychara added 1 commit 2025-11-12 20:15:53 -08:00
chore: audit contributing docs
Node.js CI / Lint and Test (pull_request) Failing after 35s
Details
73beb11b3b
nerdychara added 1 commit 2025-11-13 06:06:42 -08:00
remove mention of fork and update url instructions
Node.js CI / Lint and Test (pull_request) Failing after 35s
Details
f58a9d62c5
naomi reviewed 2025-11-13 14:28:04 -08:00
src/content/docs/dev/contributing.md
@@ -101,3 +100,1 @@
2. Click the "Fork" button in the upper right corner of the page.
3. Select your account as the destination for the fork.
4. Wait for Codeberg to create a copy of the repository in your account.
1. Navigate to our [contributor form](https://forms.nhcarrigan.com/form/c0_N5hb-VcmC2ClzaGOvDxVirMN_coiWG7eoPhDPsZ0).
naomi commented 2025-11-13 14:28:04 -08:00
Owner
Copy Link
Copy Source

Haaaaaaaah actually we are only granting access to folks who are staff. They'd need to apply for a technical contributor role here: https://forms.nhcarrigan.com/form/PEpB3gA79gxP8wmfEf4zou96opkpUTjssTcaeYjhoi8

Haaaaaaaah actually we are only granting access to folks who are staff. They'd need to apply for a technical contributor role here: https://forms.nhcarrigan.com/form/PEpB3gA79gxP8wmfEf4zou96opkpUTjssTcaeYjhoi8
naomi commented 2025-11-13 21:34:08 -08:00
Owner
Copy Link
Copy Source

I've done a pretty substantial docs audit and overhaul again - went ahead and pulled your changes into that process, so I'll close this PR.

I've done a pretty substantial docs audit and overhaul again - went ahead and pulled your changes into that process, so I'll close this PR.
naomi closed this pull request 2025-11-13 21:34:08 -08:00
Some required checks failed
Node.js CI / Lint and Test (pull_request) Failing after 35s
Required
Details

Pull request closed

Please reopen this pull request to perform a merge.
Sign in to join this conversation.
Reviewers
No Reviewers
naomi
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
Milestone
No items
No Milestone
Assignees
Clear assignees
gurkirat hanna (Hanna Rose) hikari (Hikari) minori (Minori) naomi (Naomi Carrigan) rain teklu tim
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: nhcarrigan/docs#11
Delete Branch "chore/audit-contributing-docs"

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?