Skip to content

Create CONTRIBUTING.md #92

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.

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

Merged
merged 20 commits into from
Mar 25, 2021
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
Update CONTRIBUTING.md
Co-authored-by: Shawn Wells <shawn@shawndwells.io>
  • Loading branch information
jshcodes and shawndwells authored Mar 25, 2021
commit d395d92bd1075a872b69522286127a4fce1e95ec
8 changes: 1 addition & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,7 @@ When you submit code changes, your submissions are understood to be under the sa
If this is a concern, contact the maintainers before contributing.

### Additional contributor package requirements
The file `requirements-dev.txt` contains additional Python requirements used for developing unit tests and for accessing the integrated debugger within FalconShell.
Review this file's contents and install these requirements before proceeding:
+ flake8
+ pytest
+ pytest-cov
+ coverage
+ iPython
`requirements-dev.txt` contains Python modules required for unit test development and for accessing the integrated debugger within FalconShell. Review this file's contents and install missing requirements as needed.

### Unit testing & Code coverage
+ All submitted code must also have an associated unit test that tests __all__ code paths within this new segment. (:100: percent coverage)
Expand Down