Skip to content

Commit 733c6c5

Browse files
[pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
1 parent 2e147f9 commit 733c6c5

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,61 +9,61 @@ Thank you for your interest in contributing to COSMOS! We welcome contributions
99
### 1. **Create an Issue on the Repo**
1010

1111
1. **Navigate to Your Repository**:
12-
12+
1313
```bash
1414
$ cd path/to/your/repository
1515
```
16-
16+
1717
2. **Create an Issue**:
1818
Use the `gh issue create` command to create a new issue.
19-
19+
2020
```bash
2121
$ gh issue create --title "Issue Title" --body "Description of the issue"
2222
```
23-
23+
2424
After running this command, you’ll get an issue number in the output. Note this number as it will be used to create a branch.
25-
25+
2626

2727
### 2. **Create a Branch for the Issue**
2828

2929
1. **Create a Branch**:
3030
Use the `gh` CLI to create a branch associated with the issue. The `gh` CLI can automatically create a branch for you based on the issue number. In this case, the `<issue_number>` is 989.
31-
31+
3232
```bash
3333
$ gh issue develop -c 989
34-
github.com/NASA-IMPACT/COSMOS/tree/989-make-coding-syntax-consistent
35-
From https://github.com/NASA-IMPACT/COSMOS
34+
github.com/NASA-IMPACT/COSMOS/tree/989-make-coding-syntax-consistent
35+
From https://github.com/NASA-IMPACT/COSMOS
3636
* [new branch] 989-make-coding-syntax-consistent -> origin/989-make-coding-syntax-consistent
37-
37+
3838
```
39-
39+
4040
This command creates a new branch named `<issue_number>-issue` and switches to it. This branch will be used to work on the issue.
41-
41+
4242
2. **Make Your Changes and Push:**
4343
Edit files, add code, or make any changes needed to address the issue. Commit your changes and push the branch to the remote repository.
44-
44+
4545
```bash
4646
git add .
4747
git commit -m "Fixes issue #<issue_number>"
4848
git push origin <issue_number>-issue
4949
```
50-
50+
5151

5252
### 3. **Create a Pull Request**
5353

5454
1. **Create the Pull Request**:
5555
After pushing the branch, create a pull request using the `gh pr create` command:
56-
56+
5757
```bash
5858
gh pr create --base dev --head <issue_number>-issue --title "Title of the Pull Request" --body "Description of the changes"
5959
```
60-
60+
6161
- **`-base`**: The base branch you want to merge your changes into (`dev` in our case)
6262
- **`-head`**: The branch that contains your changes (e.g., `<issue_number>-issue`).
6363
- **`-title`**: The title of the pull request.
6464
- **`-body`**: The description or body of the pull request.
65-
65+
6666
This command will create a pull request from your branch into the base branch specified.
67-
67+
6868
2. **Review and Merge**:
69-
Once the pull request is created, you can review it on GitHub and merge it if everything looks good.
69+
Once the pull request is created, you can review it on GitHub and merge it if everything looks good.

0 commit comments

Comments
 (0)