Skip to content

Latest commit

 

History

History
100 lines (69 loc) · 3.02 KB

contributing.md

File metadata and controls

100 lines (69 loc) · 3.02 KB

Contributing to Clean Actions

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Types of Contributions

Report Bugs

Report bugs on the Github Repo.

If you are reporting a bug, please include:

  • The version you are running
  • Any details about your local setup that might be helpful
  • Reproduction steps

Fix Bugs

Look through the Github issues for bugs. Anything tagged with "bug" or "help wanted" is open to whoever wants to implement it.

Implementing Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

Clean Actions could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue on Github.

If you are proposing a feature:

  • Explain in detail how it would work
  • Keep the scope as narrow as possible, to make it easier to implement
  • Try to give an example of what you're looking for
  • Remember that this is a volunteer-driven project, and that contributions are welcome

Get Started

Ready to contribute? Here's how to set up Clean Actions for local development.

  1. Fork the repo on Github
  2. Clone your fork locally
  3. Setup a virtual environment We recommend using pyenv for this, which can be easily installed with the installer on supported OSs.
  4. Install flit.
  5. Install the development dependencies You can use make install for this, or flit install --pth-file.
  6. Checkout a new branch (git checkout -b branch-name) Now you can make your changes locally
  7. Once you're done, make sure Linting and Testing passes

Validating Changes

Linting

3 Linters have been set up to adhere to our style guidelines:

  • isort
  • black
  • autoflake

You can check your changes by running make lint to get a report.

To fix any linting issues, run:

make fixlint

Testing

Testing is as simple as running:

make test

This will run the pytest suite. Note that there are 2 important plugins loaded as part of this:

  • pytest-cov Generates a coverage report of the tests
  • pytest-randomly Ensures that tests don't always run in the same order (prevents order dependent tests)