From 73beb11b3b7004a92f41b0642695dfe874908b97 Mon Sep 17 00:00:00 2001 From: Anna Date: Thu, 18 Sep 2025 20:39:10 -0400 Subject: [PATCH 1/2] chore: audit contributing docs --- src/content/docs/dev/contributing.md | 41 ++++++++++++++-------------- 1 file changed, 20 insertions(+), 21 deletions(-) diff --git a/src/content/docs/dev/contributing.md b/src/content/docs/dev/contributing.md index 4d19d84..1adc297 100644 --- a/src/content/docs/dev/contributing.md +++ b/src/content/docs/dev/contributing.md @@ -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 ``` -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 @@ -373,11 +372,11 @@ git push -u origin - `origin` specifies your forked repository as the destination - `` 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. -- 2.52.0 From f58a9d62c5f2283102d378b2c00a23dbc7394a48 Mon Sep 17 00:00:00 2001 From: Anna Cottrill Date: Thu, 13 Nov 2025 09:05:44 -0500 Subject: [PATCH 2/2] remove mention of fork and update url instructions --- src/content/docs/dev/contributing.md | 74 ++++++++-------------------- 1 file changed, 21 insertions(+), 53 deletions(-) diff --git a/src/content/docs/dev/contributing.md b/src/content/docs/dev/contributing.md index 1adc297..cb16614 100644 --- a/src/content/docs/dev/contributing.md +++ b/src/content/docs/dev/contributing.md @@ -98,72 +98,40 @@ To work with secrets locally, you must set up the 1Password CLI (Command Line In ### 3.1 Gaining a contributor account 1. Navigate to our [contributor form](https://forms.nhcarrigan.com/form/c0_N5hb-VcmC2ClzaGOvDxVirMN_coiWG7eoPhDPsZ0). -2. Fill out the web form. +2. Fill out the web form. 3. Wait for Naomi to approve your account. -### 3.2 Cloning Your Fork +### 3.2 Cloning A Project -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). +1. Go to repository on NHCarrigan's Git instance. +2. Click the "Code" button and copy the HTTPS URL. 3. Open your terminal or command prompt. 4. Navigate to the directory where you want to store the project. 5. Run the following command, replacing `` with the URL you copied: - ``` + ```bash git clone ``` 6. Enter your Git credentials if prompted. -### 3.3 Setting Up the Upstream Remote - -Adding the original repository as an upstream remote allows you to easily keep your fork up-to-date. - -1. Change into the project directory: - - ``` - cd - ``` - -2. Add the upstream remote: - - ``` - git remote add upstream - ``` - - Replace `` with the **git** URL of the original repository. - -3. Verify the new remote: - - ``` - git remote -v - ``` - - You should see entries for both `origin` (your fork) and `upstream`. - -### 3.4 Keeping Your Clone Up-to-Date +### 3.3 Keeping Your Clone Up-to-Date Regularly update your clone to incorporate changes from the upstream repository: -1. Fetch the branches and commits from the upstream repository: +1. Check out the main branch: - ``` - git fetch upstream - ``` - -2. Check out your fork's local main branch: - - ``` + ```bash git checkout main ``` -3. Pull changes from upstream to your local clone: +2. Pull changes from upstream to your local clone: - ``` + ```bash git pull ``` -### 3.5 Troubleshooting +### 3.4 Troubleshooting If you encounter any issues during setup: @@ -205,10 +173,10 @@ We encourage collaboration and pair programming on complex issues! ### 4.5 Working on the Issue -1. Once assigned, create a new branch in your fork for this specific issue. +1. Once assigned, create a new branch in the project for this specific issue. 2. Use a descriptive branch name, e.g., `fix/issue-123-button-alignment`. 3. Make your changes, committing regularly with clear, concise commit messages. -4. Push your changes to your fork. +4. Push your changes to your branch. 5. Open a pull request when ready for review (see Pull Request Guidelines in section [X]). ### 4.6 Keeping the Community Updated @@ -246,13 +214,13 @@ Pay attention to issue labels for additional context: ### 5.1 Updating Your Clone -Before starting work, ensure your clone is up to date with the original repository. +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 + git checkout main git pull ``` @@ -281,7 +249,7 @@ Always create a new branch for your work: 1. Make your code changes, following the project's coding standards and guidelines. 2. Regularly commit your changes with clear, concise messages. -3. Push your changes to your fork periodically: +3. Push your changes to your branch periodically: ```bash git push origin @@ -320,7 +288,7 @@ When you're ready to commit your changes: Example: -``` +```md feat: add user authentication system Implement JWT-based authentication for API endpoints. @@ -369,7 +337,7 @@ git push -u origin ``` - `-u` sets the upstream, linking your local branch to the remote branch -- `origin` specifies your forked repository as the destination +- `origin` specifies the project repository as the destination - `` is the name of your local branch 2. Ensure the push is successful and your changes appear in the repository on NHCarrigan's Git instance. @@ -379,7 +347,7 @@ git push -u origin 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. +4. Select the project as the head repository and your recently pushed branch as the compare branch. ### 6.3 Filling Out the Pull Request @@ -408,7 +376,7 @@ If you need to make changes to your pull request: 1. Make the required changes in your local branch. 2. Commit the changes. -3. Push the new commits to your fork: +3. Push the new commits to your branch: ```bash git push origin @@ -426,7 +394,7 @@ If you need to make changes to your pull request: ### 6.8 Merging and Closing - Once your pull request is approved, a maintainer will merge it into the main project. -- After merging, you can delete your branch from your fork if you won't be using it anymore. +- After merging, you can delete your branch from the repository if you won't be using it anymore. - Celebrate your contribution to the project! ## 7. Pull Request Reviews -- 2.52.0