Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 1.18 KB

CONTRIBUTING.md

File metadata and controls

44 lines (27 loc) · 1.18 KB

Contributing to this project

Thanks for your interest in contributing to our project 👍 👍

Reporting an Issue

Found an issue in our code or have an idea how to improve?

  1. Check if your issue or idea has already been reported: See Issues
  2. Create an issue, but don't forget to provide a test case or even a live example: Create Issue

Make sure to also check the documentation on how to set up a local development environment and run the required tests: See Documentation

Submitting a Pull Request

Want to contribute to the project? That's awesome!

  1. Let's start with a fork of the project

  2. Clone your fork:

git clone [CLONE URL PROVIDED BY GITHUB]
  1. Create a new branch:
git checkout -b feature/short-description
  1. Push your branch to your fork:
git push origin feature/short-description
  1. Open a Pull Request

Just make sure that:

  • Your pull request is focused and you avoid unrelated commits
  • Ensure your code passes the pre-commit hook that is part of the repository and also the github workflow.
  • You read and accept our Contributor License Agreement