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
  • Loading branch information
jshcodes authored Mar 25, 2021
commit d76122594044132eb4ea0bab6d6c33d71b685faf
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ 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
Expand All @@ -55,6 +56,9 @@ Review this file's contents and install these requirements before proceeding:
- For scenarios where unit testing passes in the PR and fails post-merge, a maintainer will address the issue. If the problem is programmatic and related to code within the pull request, the merge may be reverted.
+ The util folder contains BASH scripts for triggering unit tests that match unit testing performed as part of our GitHub workflows.

### Linting
All submitted code must meet minimum linting requirements. We use `flake8` for linting. Refer to the "lint.sh" script within the util folder to review our standard linting parameters.

### Branch targeting
_Please do not target the `main` branch with your Pull Request unless directed to do so by a maintainer_. Instead, target your PR at the most recent development branch.

Expand Down