Creating Contribution Guide (#644)

This merge is a test to see if Lighthouse CI is being honest to us or not Co-authored-by: dorian451 <112524240+dorian451@users.noreply.github.com>
YACS-RCOS · Jan 30, 2023 · ef51821 · ef51821
1 parent 0456edf
commit ef51821
Show file tree

Hide file tree

Showing 16 changed files with 54 additions and 0 deletions.
diff --git a/docs/contributing/how_to_review.md b/docs/contributing/how_to_review.md
@@ -0,0 +1,13 @@
+# How to Review a Pull Request
+
+1. Find  a pull request.
+2. Find the name of the branch in the pull request:
+   * ![showing name of a pull request](img/pull_request_name.png)
+   * In this case, the branch name would be `contributing_guide`.
+3. Open a terminal and navigate to your local repository (the `yacs.n` folder)
+4. Make sure your computer's repo is up to date by running `git pull`.
+5. Run `git switch <branch name>`.
+6. On some computers, if you are running the local version of YACS already, it will update automatically. If it doesn't, restart Docker and refresh the localhost page.
+7. Look at the pull request and verify that whatever functionality it adds works and doesn't seem to cause any problems. 
+8. Add your review (whether it's an approval or not) hitting the "add your review" button:
+   * ![add your review](img/add_review.png)
diff --git a/docs/contributing/img/add_review.png b/docs/contributing/img/add_review.png
diff --git a/docs/contributing/img/assign_branch.png b/docs/contributing/img/assign_branch.png
diff --git a/docs/contributing/img/feature_request.png b/docs/contributing/img/feature_request.png
diff --git a/docs/contributing/img/feature_request_template.png b/docs/contributing/img/feature_request_template.png
diff --git a/docs/contributing/img/inprogress_label.png b/docs/contributing/img/inprogress_label.png
diff --git a/docs/contributing/img/issue.png b/docs/contributing/img/issue.png
diff --git a/docs/contributing/img/issue_assign.png b/docs/contributing/img/issue_assign.png
diff --git a/docs/contributing/img/issue_listing.png b/docs/contributing/img/issue_listing.png
diff --git a/docs/contributing/img/navigating_to_branch.png b/docs/contributing/img/navigating_to_branch.png
diff --git a/docs/contributing/img/new_issue.png b/docs/contributing/img/new_issue.png
diff --git a/docs/contributing/img/new_pull_request.png b/docs/contributing/img/new_pull_request.png
diff --git a/docs/contributing/img/opening_pull_request.png b/docs/contributing/img/opening_pull_request.png
diff --git a/docs/contributing/img/pull_request_name.png b/docs/contributing/img/pull_request_name.png
diff --git a/docs/contributing/opening_an_issue.md b/docs/contributing/opening_an_issue.md
@@ -0,0 +1,15 @@
+# Opening an Issue:
+
+1. Go to issues and hit "New Issue":
+
+* ![new issue button](img/new_issue.png)
+
+2. Hit "Feature Request":
+
+* ![get started button](img/feature_request.png)
+
+3. Fill out the template (make sure to add the appropriate labels/projects!):
+
+* ![template screenshot](img/feature_request_template.png)
+
+4. Hit submit issue when done.
diff --git a/docs/contributing/working_on_an_issue.md b/docs/contributing/working_on_an_issue.md
@@ -0,0 +1,26 @@
+# Working on an Issue:
+
+1. Find an issue you want to work on and open it:
+
+* ![issues page with one issue highlighted](img/issue_listing.png)
+
+2. Assign yourself to the issue:
+
+* ![assigning self to issue](img/issue_assign.png)
+
+3. Add the "in progress" label:
+
+* ![assigning in progress label](img/inprogress_label.png)
+
+4. Create / assign a branch to the issue:
+
+* ![creating a branch for the issue](img/assign_branch.png)
+
+5. When done, make a pull request:
+
+* click the branch name in the issue:
+	* ![hitting branch name](img/navigating_to_branch.png)
+* Hit "Contribute", then hit "Open pull request":
+	* ![opening the pull request](img/opening_pull_request.png)
+* Fill out the template and, when ready, hit "Create pull Request": (make sure to assign yourself in the Assignees section!)
+	* ![new pull request page](img/new_pull_request.png)