Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

shadowreader/CONTRIBUTING.md

Go to file
 
 
Cannot retrieve contributors at this time
Contributing Reporting issues Testing
42 lines (29 sloc) 1.08 KB
Raw Blame
Open in GitHub Desktop

Contributing

Please send a GitHub Pull Request with a clear list of what you've done

Currently, only Python3.6+ and AWS is supported

Please follow PEP8, but the line length limit may be ignored if following it would make the code uglier.

Reporting issues

  • Describe what you expected to happen.
  • If possible, include an example to help us identify the issue.
  • Describe what actually happened. Include the full traceback if there was an exception.
  • List your Python version, any associated AWS resources you are having trouble with

Testing

Testing is conducted with Pytest and tests are located inside /tests. Please write new tests for new code you create.

Set these enviroment variables before running any unit tests:

stage=local
region=us-east-1

Running the tests

Run the basic test suite:
    pytest tests/unit

Running test coverage:
    pytest tests/unit --cov .

Running test coverage with HTML report:
    pytest tests/unit--cov . --cov-report html --cov-branch
    # then open htmlcov/index.html

Read more about coverage <https://coverage.readthedocs.io>