chore: audit contributing docs
Node.js CI / Lint and Test (pull_request) Failing after 35s

This commit is contained in:
2025-09-18 20:39:10 -04:00
committed by Anna Cottrill
parent 0daef2fdc6
commit 73beb11b3b
+20 -21
View File
@@ -24,8 +24,8 @@ In case of any discrepancy between this document and project-specific guidelines
All commits must be cryptographically signed using either GPG or SSH. This requirement serves to verify the authenticity and integrity of your contributions.
- For GPG signing, ensure your GPG key is associated with your GitHub or Codeberg account.
- For SSH signing, use a key linked to your GitHub or Codeberg account.
- For GPG signing, ensure your GPG key is associated with your Github or NHCarrigan Git account.
- For SSH signing, use a key linked to your Github or NHCarrigan Git account.
By signing your commit, you are certifying that:
@@ -95,16 +95,15 @@ To work with secrets locally, you must set up the 1Password CLI (Command Line In
## 3. Setting Up Your Development Environment
### 3.1 Forking the Repository
### 3.1 Gaining a contributor account
1. Navigate to the original repository on Codeberg.
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).
2. Fill out the web form.
3. Wait for Naomi to approve your account.
### 3.2 Cloning Your Fork
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).
3. Open your terminal or command prompt.
4. Navigate to the directory where you want to store the project.
@@ -114,7 +113,7 @@ To work with secrets locally, you must set up the 1Password CLI (Command Line In
git clone <url>
```
6. Enter your GitHub credentials if prompted.
6. Enter your Git credentials if prompted.
### 3.3 Setting Up the Upstream Remote
@@ -142,9 +141,9 @@ Adding the original repository as an upstream remote allows you to easily keep y
You should see entries for both `origin` (your fork) and `upstream`.
### 3.4 Keeping Your Fork Up-to-Date
### 3.4 Keeping Your Clone Up-to-Date
Regularly update your fork to incorporate changes from the upstream repository:
Regularly update your clone to incorporate changes from the upstream repository:
1. Fetch the branches and commits from the upstream repository:
@@ -158,10 +157,10 @@ Regularly update your fork to incorporate changes from the upstream repository:
git checkout main
```
3. Merge changes from upstream/main into your local main branch:
3. Pull changes from upstream to your local clone:
```
git merge upstream/main
git pull
```
### 3.5 Troubleshooting
@@ -172,7 +171,7 @@ If you encounter any issues during setup:
2. Search for similar issues in the project's issue tracker.
3. If the problem persists, open a new issue with detailed information about the problem and steps to reproduce it.
You can also reach out to us on our forum: https://forum.nhcarrigan.com
You can also reach out to us on our Discord: https://chat.nhcarrigan.com/
## 4. Claiming an Issue
@@ -245,16 +244,16 @@ Pay attention to issue labels for additional context:
## 5. Working on Your Issue
### 5.1 Updating Your Fork
### 5.1 Updating Your Clone
Before starting work, ensure your forked version is up to date with the original repository. If you've set up the `upstream` remote as mentioned in Section 3, follow these steps:
Before starting work, ensure your clone is up to date with the original repository.
1. Open your terminal and navigate to your project's root directory.
2. Run the following commands:
```bash
git fetch upstream
git merge upstream/main
git fetch
git pull
```
### 5.2 Creating a New Branch
@@ -363,7 +362,7 @@ If you're unsure about any part of the process or need help, don't hesitate to a
### 6.1 Pushing Your Changes
1. Push your changes to your forked repository:
1. Push your changes to the repository:
```bash
git push -u origin <branchname>
@@ -373,11 +372,11 @@ git push -u origin <branchname>
- `origin` specifies your forked repository as the destination
- `<branchname>` is the name of your local branch
2. Ensure the push is successful and your changes appear in your forked repository on Codeberg.
2. Ensure the push is successful and your changes appear in the repository on NHCarrigan's Git instance.
### 6.2 Creating the Pull Request
1. Navigate to your forked repository on Codeberg.
1. Navigate to the repository on NHCarrigan's Git instance.
2. You should see a prompt to create a pull request for your recently pushed branch. If not, click on the "Pull requests" tab and then the "New pull request" button.
3. Ensure the base repository is the original project repository and the base branch is `main`.
4. Select your fork as the head repository and your recently pushed branch as the compare branch.