Skip to content

Commit 14108be

Browse files
committed
content updates
1 parent b112896 commit 14108be

1 file changed

Lines changed: 34 additions & 29 deletions

File tree

contributing.md

Lines changed: 34 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,58 @@
11
# Contributing File
22

33
# Welcome to pyQuARC!
4-
This page is meant to help you learn how you can contribute to pyQuARC Content! We are passionate about NASA's Open Science initiative and we want your help. 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!
5-
## Getting Started
6-
#### What is pyQuARC?
7-
PyQuARC is a tool that can helpp streamline the process of metadata assessment by automating it as much as possible. It completes basic validation checks, flags areas that need contextual metadata, and confirms information associated with both the collection level metadata and granuale level metadata are consistent. Read more about pyQuARC in the project's [**Read Me File**](https://github.com/NASA-IMPACT/pyQuARC?tab=readme-ov-file#pyquarc).
4+
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.
85

96
## How you can contributute to pyQuARC:
10-
We will start realativly simple, and progress to the more difficult ways to contribute.
117

128
1. **Report a Bug:** for when you find something within the code that does not respond the way you expected/wanted it to.
13-
* To start you will need to proceed to the **Issues** tab within the [pyQuARC Github Page](https://github.com/NASA-IMPACT/pyQuARC/issues).
9+
* To start you will need to proceed to the [**Issues** tab](https://github.com/NASA-IMPACT/pyQuARC/issues) within the pyQuARC Github page.
1410
* From here, look for the green button on the right side of the page labeled **New issue**.
1511
* Select **Bug Report** from the list that appears, so that you can create a report to help us improve an aspect of pyQuARC.
1612
* 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.
1713
* 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.
18-
* 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 will help us to make pyQuARC more user friendly!
14+
* 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.
1916
* 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.
20-
* Thank you for submitting a bug report to our team! We know that your report will help to better pyQuARC for everyone.
2117

2218
2. **Suggest a New Feature:** for when you think of something that could enhance pyQuARC for other users.
23-
* Suggesting a new feature is very similar to reporting a bug. You will start at the **Issues** tab within the [pyQuARC Github Page](https://github.com/NASA-IMPACT/pyQuARC/issues).
19+
* 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.
2420
* Select the green **New Issue** button found on the top right side of the page.
2521
* From the menu that appears, select **Feature Request** so that you can suggest an idea for our project.
2622
* The page you are directed to will provide a prompt to add a title and explains how to make a new suggestion.
2723
* 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.
28-
* 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 and will help us to make pyQuARC more user friendly!
24+
* 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.
2926
* 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.
30-
* Thank you for suggesting a new feature or enhancment to our team! Your suggestiong will help us to better pyQuARC for everyone.
31-
32-
3. **Directly Contribute to PyQuARC Content:** for when you want to directly edit the code to add checks, or play around and see how things work.
33-
* 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, but allows you to create your own edits freely without changing the original repository. Read more about Forks [Here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)
34-
* To create your own fork of pyQuARC, return to the [**Code**](https://github.com/NASA-IMPACT/pyQuARC) tab of the pyQuARC GitHub.
35-
* On the top right of the page select the **Fork** tab.
36-
* Under the "Owner" dropdowm menu select yourself as the owner of the new forked repository.
37-
* The fork name will default to 'pyQuARC'. If you wish to name your fork something different, edit the 'Repository Name' field.
38-
* You can set an optional description in the 'Description' field below.
39-
* Make sure the checkbox next to 'Copy the master branch only' is checked.
40-
* Click **Create fork** when you are finished to create your fork!
41-
* After completing the steps above, you should be in a new page titled the same as your new fork. You have successfully created a fork of pyQuARC! You shpuld be able to see all the pyQuARC files and the Read Me.
42-
* 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**.
43-
* Under the **HTTPS** tab, copy the link to the repository.
44-
* Open a python terminal in your preferred coding location.
45-
* Change your working directory to wherever you want your cloned pyQuARC repository to be stored.
46-
* Type '__git clone__' and then paste the URL you copied a few steps above.
47-
* Press **Enter** and your local clone of pyQuARC will be created! You can now explore all of the files on your local computer and make changes as you wish.
27+
28+
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.
34+
* The fork name will default to 'pyQuARC'. If you wish to name your fork something different, edit the 'Repository Name' field.
35+
* You can set an optional description in the 'Description' field below.
36+
* Make sure the checkbox next to 'Copy the master branch only' is selected.
37+
* 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!
39+
* Clone your fork locally
40+
* 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**.
41+
* Under the **HTTPS** tab, copy the link to the repository.
42+
* Open a python terminal in your preferred coding location.
43+
* Change your working directory to wherever you want your cloned pyQuARC repository to be stored.
44+
* Type '__git clone__' and then paste the URL you copied a few steps above.
45+
* Press **Enter** and your local clone of pyQuARC will be created! You can now explore all of the files on your local computer.
46+
* Create a new branch and make your desired changes.
47+
* Create a PR
48+
* Once your changes are made, push your commits.
49+
* 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".
51+
* Fill out a title and description, then submit!
52+
* Feedback may be provided on your PR. Once it is approved, a pyQuARC team member will merge your changes.
4853

4954
## Thank you for your interest in pyQuARC!
50-
We appriciate your interest in our metadata review project! In the spirit of Open Science, 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 to improve pyQuARC, and we welcome your comments, suggestions, and new ideas!
5156

5257

5358

0 commit comments

Comments
 (0)