Skip to content

Commit 150bff5

Browse files
authored
Fix grammatical errors
1 parent 65411d8 commit 150bff5

1 file changed

Lines changed: 13 additions & 17 deletions

File tree

contributing.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,39 +3,39 @@
33
# Welcome to pyQuARC!
44
This page is meant to help you learn how you can contribute to pyQuARC! We are passionate about NASA's Open Science initiative and are open to a variety of contributions. Read below to find ways that you can contribute to our project, either through reporting bugs, suggesting new features, or even directly editing the code yourself.
55

6-
## How you can contributute to pyQuARC:
6+
## How you can contribute to pyQuARC:
77

88
1. **Report a Bug:** for when you find something within the code that does not respond the way you expected/wanted it to.
99
* To start you will need to proceed to the [**Issues** tab](https://github.com/NASA-IMPACT/pyQuARC/issues) within the pyQuARC Github page.
1010
* From here, look for the green button on the right side of the page labeled **New issue**.
1111
* Select **Bug Report** from the list that appears, so that you can create a report to help us improve an aspect of pyQuARC.
12-
* The page you are directed to will provide a prompt to add a title and explains how to fill in the bug you are wanting to report.
12+
* The page you are directed to will provide a prompt to add a title and explain how to fill in the bug you want to report.
1313
* If you change your mind about reporting a bug, there is a white button on the bottom right of the page labeled **Cancel** where you can either decide to keep editing or close and discard your issue.
1414
* Beneath the description box, select "Issue Type" and "Bug".
15-
* When you are finished describing the bug you wish to report, you can click the big green button at the bottom of the page labeled **Create**. This will make your Issue visible to all pyQuARC contributers, and pyQuARC developers will automatically be assigned to the Issue and notified.
15+
* When you are finished describing the bug you wish to report, you can click the big green button at the bottom of the page labeled **Create**. This will make your Issue visible to all pyQuARC contributors, and pyQuARC developers will automatically be assigned to the Issue and notified.
1616
* You can see your new issue if you return to the **Issues** page of the pyQuARC GitHub and look for your title followed by the red __bug__ tag.
1717

1818
2. **Suggest a New Feature:** for when you think of something that could enhance pyQuARC for other users.
1919
* Suggesting a new feature is very similar to reporting a bug. You will start at the [**Issues** tab](https://github.com/NASA-IMPACT/pyQuARC/issues) within the pyQuARC Github page.
2020
* Select the green **New Issue** button found on the top right side of the page.
2121
* From the menu that appears, select **Feature Request** so that you can suggest an idea for our project.
22-
* The page you are directed to will provide a prompt to add a title and explains how to make a new suggestion.
22+
* The page you are directed to will provide a prompt to add a title and explain how to make a new suggestion.
2323
* If you change your mind about making a feature request, there is a white button on the bottom right of the page labeled **Cancel** where you can either decide to keep editing or close and discard your issue.
2424
* Beneath the description box, select "Issue Type" and "Feature".
25-
* When you are finished describing your suggestion, you can click the big green button at the bottom of the page labeled **Create**. This will make your Issue visible to all pyQuARC contributers.
25+
* When you are finished describing your suggestion, you can click the big green button at the bottom of the page labeled **Create**. This will make your Issue visible to all pyQuARC contributors.
2626
* You can see your new issue if you return to the **Issues** page of the pyQuARC GitHub and look for your title followed by the green __new check__ tag.
2727

2828
3. **Directly Contribute to PyQuARC Content:** for when you want to directly edit the code to add checks or new features.
29-
* Fork the respository
30-
* To edit the code you will need to first create your own 'fork' of the repository. A fork is a new repository that shares code and visibilty settings with the original repository, and allows you to create your own edits. Read more about Forks [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo).
31-
* To create your own fork of pyQuARC, return to the [**Code**](https://github.com/NASA-IMPACT/pyQuARC) tab of the pyQuARC GitHub.
32-
* On the top right of the page select the **Fork** tab.
33-
* Under the "Owner" dropdown menu select yourself as the owner of the new forked repository.
29+
* Fork the repository
30+
* To edit the code, you will need to first create your own 'fork' of the repository. A fork is a new repository that shares code and visibility settings with the original repository and allows you to create your edits. Read more about Forks [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo).
31+
* To create your fork of pyQuARC, return to the [**Code**](https://github.com/NASA-IMPACT/pyQuARC) tab of the pyQuARC GitHub.
32+
* On the top right of the page, select the **Fork** tab.
33+
* Under the "Owner" dropdown menu, select yourself as the owner of the new forked repository.
3434
* The fork name will default to 'pyQuARC'. If you wish to name your fork something different, edit the 'Repository Name' field.
3535
* You can set an optional description in the 'Description' field below.
3636
* Make sure the checkbox next to 'Copy the master branch only' is selected.
3737
* Click **Create fork** when you are finished to create your fork!
38-
* After completing the steps above, you should be in a new page titled the same as your new fork, with "forked from NASA-IMPACT/pyQuARC" beneath the title. You have successfully created a fork of pyQuARC!
38+
* After completing the steps above, you should be on a new page titled the same as your new fork, with "forked from NASA-IMPACT/pyQuARC" beneath the title. You have successfully created a fork of pyQuARC!
3939
* Clone your fork locally
4040
* Now we will store the files locally on your computer so you will be able to edit the code. Click the green dropdown button labeled **<> Code**.
4141
* Under the **HTTPS** tab, copy the link to the repository.
@@ -47,14 +47,10 @@ This page is meant to help you learn how you can contribute to pyQuARC! We are p
4747
* Create a PR
4848
* Once your changes are made, push your commits.
4949
* You can then open a Pull Request (PR) on the [**Pull requests** tab](https://github.com/NASA-IMPACT/pyQuARC/pulls) within the pyQuARC Github page.
50-
* Set the base respository to "NASA-IMPACT/pyQuARC" and the base to "dev".
50+
* Set the base repository to "NASA-IMPACT/pyQuARC" and the base to "dev".
5151
* Fill out a title and description, then submit!
5252
* Feedback may be provided on your PR. Once it is approved, a pyQuARC team member will merge your changes.
5353

5454
## Thank you for your interest in pyQuARC!
55-
We appreciate your interest in pyQuARC! Everyone is encouraged to help to improve pyQuARC, and we welcome your comments, suggestions, and new ideas!
55+
We appreciate your interest in pyQuARC! Everyone is encouraged to help improve pyQuARC, and we welcome your comments, suggestions, and new ideas!
5656
Please contact earthdata-support@nasa.gov with any questions.
57-
58-
59-
60-

0 commit comments

Comments
 (0)