Skip to content

Latest commit

 

History

History
27 lines (17 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

27 lines (17 loc) · 1.08 KB

Contributing to Compliance Assistant

Thank you for your interest in this project. Contributions are welcome. Feel free to open an issue with questions or reporting ideas and bugs, or open pull requests to contribute code.

We are committed to fostering a welcoming, respectful, and harassment-free environment. Be kind!

Development setup

Starting development is as easy as installing Python poetry and running poetry install once.

In order to run the project in the new virtual environment, run poetry run compliance-assistant.

Contribution workflow

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix: git checkout -b feature-or-fix-name
  3. Make your changes and commit them with descriptive messages.
  4. Push your changes to your forked repository: git push origin feature-or-fix-name
  5. Open a Pull Request on the main repository.

It is assumed that you contribute under the main license of the project and own all the rights to the content you submit.