Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (29 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

42 lines (29 loc) · 1.89 KB
Raw

Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Contributions to this project are released to the public under the project's open source license.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Submitting a pull request

  1. Fork and clone the repository.
  2. Create a new branch: git checkout -b my-branch-name.
  3. Make your change, add tests, and make sure the tests pass.
  4. Push to your fork and submit a pull request.
  5. Ensure the required checks pass.

Run the local unit tests with:

python -m unittest discover -s tests -p "test_*.py" -v

Cache release development does not require GitHub Actions. The codeql-bundle-cache commands documented in the README perform release inspection, cache construction, cache-hit verification, and catalog generation locally. The workflow should remain a thin wrapper around those commands.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Write tests.
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Resources