diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8cc722554c..c87ae17ecd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,9 +41,9 @@ Tips for Pull Requests To make the QA process go as smoothly as possible. 1. Have a basic description in your pull request. -2. Write a basic test plan if added features. -3. If added any new api make sure they come with some documentation included. -4. If accessing any external service make note of how to get a basic setup for these services or what they are based on. +2. Write a basic test plan if you are altering or adding features. +3. If a new API is added, try to make sure that some level of basic documentation on how you can utilize it is included. +4. If an added API or feature requires an external service, try to document or link to instructions on how to create a basic working setup. Reporting Bugs === @@ -54,4 +54,4 @@ Reporting Bugs Requesting a Feature === 1. Search [issues](https://github.com/kasenvr/project-athena/issues) to make sure that somebody has not already requested the same feature. -2. [Add](https://github.com/kasenvr/project-athena/issues/new) your request to the issues list! \ No newline at end of file +2. [Add](https://github.com/kasenvr/project-athena/issues/new) your request to the issues list!