Skip to content
Snippets Groups Projects
Commit abf8e839 authored by Colton Leekley-Winslow's avatar Colton Leekley-Winslow Committed by GitHub
Browse files

Merge pull request #469 from scitran/pr-review-guidelines

Add PR guidelines
parents 98a62e5d d9bbceca
No related branches found
No related tags found
No related merge requests found
......@@ -16,8 +16,12 @@ pip list --local --outdated
Then review and decide what upgrades to make, if any.
Changes to `requirements.txt` should always be by pull request.
## Code Standards
### Testing
- Add tests for every change made
- Tests should be realistic and exercise a wide range of possibilities
### Docstrings
- Use [Google Style Docstrings](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html).
- Add docstrings to all functions with a one-line description of its purpose.
......@@ -35,6 +39,10 @@ Ensure that `./test/bin/lint.sh api` exits without errors.
1. Choose a descriptive name for your resource that aligns with existing names.
1. Create a URL from the name. If your resource is a collection, the name should be a pluralized noun, e.g., "files".
### Quality Standards
1. All API resources must have input validation
1. New API resources should follow the error handling convention and raise webapp2.HTTPException
### Add RAML for API Endpoints
1. Create a new resource file, called `<resource_name>.raml`, e.g., `files.raml`. Create this file in the `raml/resources` directory.
1. In `api.raml`, add a line with the URL of your resource and an include directive for your resource raml file, e.g., `/files: !include resources/files.raml`.
......
### Review Checklist
- Tests were added to cover all code changes
- Documentation was added / updated
- Code and tests follow standards in CONTRIBUTING.md
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment