chore: audit contributing docs #11

Closed
nerdychara wants to merge 2 commits from chore/audit-contributing-docs into main
Showing only changes of commit f58a9d62c5 - Show all commits
+18 -50
View File
1
@@ -101,69 +101,37 @@ To work with secrets locally, you must set up the 1Password CLI (Command Line In
2. Fill out the web form. 2. Fill out the web form.
3. Wait for Naomi to approve your account. 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. 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). 2. Click the "Code" button and copy the HTTPS URL.
nerdychara marked this conversation as resolved Outdated
Outdated
Review

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.
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 Git 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.
1. Change into the project directory:
```
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 Clone Up-to-Date
Regularly update your clone 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: 1. Check out the main branch:
``` ```bash
git fetch upstream
```
2. Check out your fork's local main branch:
```
git checkout main git checkout main
``` ```
3. Pull changes from upstream to your local clone: 2. Pull changes from upstream to your local clone:
``` ```bash
git pull git pull
``` ```
### 3.5 Troubleshooting ### 3.4 Troubleshooting
If you encounter any issues during setup: 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 ### 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
@@ -252,7 +220,7 @@ Before starting work, ensure your clone is up to date with the original reposito
2. Run the following commands: 2. Run the following commands:
```bash ```bash
git fetch git checkout main
git pull 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. 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>
nerdychara marked this conversation as resolved Outdated
Outdated
Review

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.
@@ -320,7 +288,7 @@ When you're ready to commit your changes:
Example: Example:
``` ```md
feat: add user authentication system feat: add user authentication system
Implement JWT-based authentication for API endpoints. Implement JWT-based authentication for API endpoints.
@@ -369,7 +337,7 @@ 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 the repository on NHCarrigan's Git instance. 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 <branchname>
1. Navigate to the repository on NHCarrigan's Git instance. 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
@@ -408,7 +376,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>
@@ -426,7 +394,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