Skip to content

Latest commit

 

History

History
84 lines (58 loc) · 5.1 KB

CONTRIBUTING.md

File metadata and controls

84 lines (58 loc) · 5.1 KB
Raw

Welcome to contributing guide

Thank you for investing your time in contributing to the project!

Read repo's Code of Conduct to keep community respectable.

TL;DR

1. Fork the repo

2. Checkout from develop branch

3. Install dependencies: pip install poetry && poetry install

3. Setup pre-commit hooks: pre-commit install --hook-type pre-commit --hook-type pre-push

4. Commit your changes with Conventional Commits

5. Run tests: poetry run tox

6. Push the changes to your fork

7. Open PR to 'develop' branch

Congrats 🎉✨. CYA in your PRs 😉

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Issues

Create a new issue

If you spot ant problems search if an issue already exists.

If an issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

View the existing issues to find something interesting to you.

In general, new issues will be assigned on Sasha.

If you find an issue to work on, just post a comment on the issue's page and you are welcome to open a PR with a fix.

Make Changes

  1. Fork the repository so that you can make your changes without affecting the original project until you're ready to merge them.
  2. Create a working branch out of 'develop' and start with your changes
  3. Install dependencies 
    pip install poetry && poetry install
  4. Setup pre-commit hooks 
    pre-commit install --hook-type pre-commit --hook-type pre-push
  5. Run tests before pushing 
    poetry run tox

Commit your update

Commit the changes once you are happy with them and push them to your fork.

Once your changes are ready, don't forget to self-review to speed up the review process:zap:.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, someone of collaborators will come and see your PR.
  • You may be asked for changes to be made before a PR can be merged, either using suggested changes or pull request comments.\
  • You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.

Your PR is merged!

Congratulations 🎉✨

Once your PR is merged, your contributions will be publicly visible on the mac-cleanup-py.