Skip to content

Updated README #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Updated README #60

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a9c7a92
Updated README
joelahoover Mar 7, 2018
79e6ddc
Merge remote-tracking branch 'origin/master' into readme
joelahoover Mar 7, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,13 @@ Thank you for any contributions!

## Testing
To test a specific function, do the following: first, ensure you are in the `testing` subdirectory by running `cd testing` from the root of the project. Then, run `python [function-name]_test.py` to test the code.

## Reviewing
In addition to implementing functions, we also need some help reviewing contributions to ensure they are implemented correctly. You can test the code using the following instructions:
1. First, find a pull request with the "Needs Testing" label.
2. On the issue, there should be a comment that says which branch the pull request is on.
3. From you local machine, type `git fetch` to get any latest changes, then checkout the pull request using `git checkout origin/[branch-name]`.
- This should make git complain about a "Detached HEAD" state, but this is fine for testing purposes.
4. Test the code as shown in the [Testing section](#Testing).
5. Comment on the pull request on Github, say whether the code works for you or if it has issues.
6. Feel free to also review the code itself, and make any suggestions!