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

feat: update contributing guidelines per Anna's PR

Browse Source 
Co-authored-by: Anna Cottrill <a.rcottrill521@gmail.com>
This commit is contained in:
Naomi Carrigan
2025-11-13 18:48:14 -08:00
parent 643d7186ef
commit 423ce6b512
1 changed files with 33 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/content/docs/dev/contributing.md
+33 -66
View File
@@ -32,8 +32,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. 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 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 Codeberg account. - For SSH signing, use a key linked to your Github or NHCarrigan Git account.
By signing your commit, you are certifying that: By signing your commit, you are certifying that:
@@ -103,76 +103,43 @@ To work with secrets locally, you must set up the 1Password CLI (Command Line In
## 3. SETTING UP YOUR DEVELOPMENT ENVIRONMENT ## 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. Contributor accounts are provided only to members of our team. If you wish to join our volunteer team, please [apply](https://forms.nhcarrigan.com/form/PEpB3gA79gxP8wmfEf4zou96opkpUTjssTcaeYjhoi8) for our Technical Contributor position.
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.
### 3.2. Cloning Your Fork Once accepted, you will be granted credentials as part of your onboarding.
1. Go to your forked repository on Codeberg. ### 3.2. Cloning A Project
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. 3. Open your terminal or command prompt.
4. Navigate to the directory where you want to store the project. 4. Navigate to the directory where you want to store the project.
5. Run the following command, replacing `<url>` with the URL you copied: 5. Run the following command, replacing `<url>` with the URL you copied:
``` ```bash
git clone <url> git clone <url>
``` ```
6. Enter your GitHub credentials if prompted. 6. Enter your Git credentials if prompted.
### 3.3. Setting Up the Upstream Remote ### 3.3. Keeping Your Clone Up-to-Date
Adding the original repository as an upstream remote allows you to easily keep your fork up-to-date. Regularly update your clone to incorporate changes from the upstream repository:
1. Change into the project directory: 1. Check out the main branch:
``` ```bash
cd <project-name>
```
2. Add the upstream remote:
```
git remote add upstream <original-repository-url>
```
Replace `<original-repository-url>` 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 Fork Up-to-Date
Regularly update your fork to incorporate changes from the upstream repository:
1. Fetch the branches and commits from the upstream repository:
```
git fetch upstream
```
2. Check out your fork's local main branch:
```
git checkout main git checkout main
``` ```
3. Merge changes from upstream/main into your local main branch: 2. Pull changes from upstream to your local clone:
``` ```bash
git merge upstream/main git pull
``` ```
### 3.5. Troubleshooting ### 3.4. Troubleshooting
If you encounter any issues during setup: If you encounter any issues during setup:
@@ -214,10 +181,10 @@ We encourage collaboration and pair programming on complex issues!
### 4.5. Working on the Issue ### 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`. 2. Use a descriptive branch name, e.g., `fix/issue-123-button-alignment`.
3. Make your changes, committing regularly with clear, concise commit messages. 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]). 5. Open a pull request when ready for review (see Pull Request Guidelines in section [X]).
### 4.6. Keeping the Community Updated ### 4.6. Keeping the Community Updated
@@ -253,16 +220,16 @@ Pay attention to issue labels for additional context:
## 5. WORKING ON YOUR ISSUE ## 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. 1. Open your terminal and navigate to your project's root directory.
2. Run the following commands: 2. Run the following commands:
```bash ```bash
git fetch upstream git checkout main
git merge upstream/main git pull
``` ```
### 5.2. Creating a New Branch ### 5.2. Creating a New Branch
@@ -290,7 +257,7 @@ Always create a new branch for your work:
1. Make your code changes, following the project's coding standards and guidelines. 1. Make your code changes, following the project's coding standards and guidelines.
2. Regularly commit your changes with clear, concise messages. 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 ```bash
git push origin <branchname> git push origin <branchname>
@@ -371,24 +338,24 @@ If you're unsure about any part of the process or need help, don't hesitate to a
### 6.1. Pushing Your Changes ### 6.1. Pushing Your Changes
1. Push your changes to your forked repository: 1. Push your changes to the repository:
```bash ```bash
git push -u origin <branchname> git push -u origin <branchname>
``` ```
- `-u` sets the upstream, linking your local branch to the remote branch - `-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
- `<branchname>` is the name of your local branch - `<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 ### 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. 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`. 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 ### 6.3. Filling Out the Pull Request
@@ -417,7 +384,7 @@ If you need to make changes to your pull request:
1. Make the required changes in your local branch. 1. Make the required changes in your local branch.
2. Commit the changes. 2. Commit the changes.
3. Push the new commits to your fork: 3. Push the new commits to your branch:
```bash ```bash
git push origin <branchname> git push origin <branchname>
@@ -435,7 +402,7 @@ If you need to make changes to your pull request:
### 6.8. Merging and Closing ### 6.8. Merging and Closing
- Once your pull request is approved, a maintainer will merge it into the main project. - 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! - Celebrate your contribution to the project!
## 7. PULL REQUEST REVIEWS ## 7. PULL REQUEST REVIEWS