diff --git a/docs/contributing/how_to_review.md b/docs/contributing/how_to_review.md new file mode 100644 index 000000000..03168bc23 --- /dev/null +++ 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 `. +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) \ No newline at end of file diff --git a/docs/contributing/img/add_review.png b/docs/contributing/img/add_review.png new file mode 100644 index 000000000..5144d1644 Binary files /dev/null and b/docs/contributing/img/add_review.png differ diff --git a/docs/contributing/img/assign_branch.png b/docs/contributing/img/assign_branch.png new file mode 100644 index 000000000..bf490bc87 Binary files /dev/null and b/docs/contributing/img/assign_branch.png differ diff --git a/docs/contributing/img/feature_request.png b/docs/contributing/img/feature_request.png new file mode 100644 index 000000000..8646c5c82 Binary files /dev/null and b/docs/contributing/img/feature_request.png differ diff --git a/docs/contributing/img/feature_request_template.png b/docs/contributing/img/feature_request_template.png new file mode 100644 index 000000000..88dfefce8 Binary files /dev/null and b/docs/contributing/img/feature_request_template.png differ diff --git a/docs/contributing/img/inprogress_label.png b/docs/contributing/img/inprogress_label.png new file mode 100644 index 000000000..d0d072494 Binary files /dev/null and b/docs/contributing/img/inprogress_label.png differ diff --git a/docs/contributing/img/issue.png b/docs/contributing/img/issue.png new file mode 100644 index 000000000..bc1e44b7b Binary files /dev/null and b/docs/contributing/img/issue.png differ diff --git a/docs/contributing/img/issue_assign.png b/docs/contributing/img/issue_assign.png new file mode 100644 index 000000000..fb79b5f29 Binary files /dev/null and b/docs/contributing/img/issue_assign.png differ diff --git a/docs/contributing/img/issue_listing.png b/docs/contributing/img/issue_listing.png new file mode 100644 index 000000000..5fee5496a Binary files /dev/null and b/docs/contributing/img/issue_listing.png differ diff --git a/docs/contributing/img/navigating_to_branch.png b/docs/contributing/img/navigating_to_branch.png new file mode 100644 index 000000000..0f8cff7d6 Binary files /dev/null and b/docs/contributing/img/navigating_to_branch.png differ diff --git a/docs/contributing/img/new_issue.png b/docs/contributing/img/new_issue.png new file mode 100644 index 000000000..38fefebdd Binary files /dev/null and b/docs/contributing/img/new_issue.png differ diff --git a/docs/contributing/img/new_pull_request.png b/docs/contributing/img/new_pull_request.png new file mode 100644 index 000000000..06ae1f91e Binary files /dev/null and b/docs/contributing/img/new_pull_request.png differ diff --git a/docs/contributing/img/opening_pull_request.png b/docs/contributing/img/opening_pull_request.png new file mode 100644 index 000000000..8ffa649a4 Binary files /dev/null and b/docs/contributing/img/opening_pull_request.png differ diff --git a/docs/contributing/img/pull_request_name.png b/docs/contributing/img/pull_request_name.png new file mode 100644 index 000000000..0cdee9d3b Binary files /dev/null and b/docs/contributing/img/pull_request_name.png differ diff --git a/docs/contributing/opening_an_issue.md b/docs/contributing/opening_an_issue.md new file mode 100644 index 000000000..b06aea3c4 --- /dev/null +++ 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. \ No newline at end of file diff --git a/docs/contributing/working_on_an_issue.md b/docs/contributing/working_on_an_issue.md new file mode 100644 index 000000000..84cc7fcb4 --- /dev/null +++ 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) \ No newline at end of file