Skip to content

Latest commit

 

History

History
69 lines (42 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

69 lines (42 loc) · 2.55 KB
Raw

Contributing

Contributions to logot are always welcome! 🤗

Questions and feedback 🤔

Please open an issue for any questions, feedback or feature requests. Asking questions can help improve the project docs, and we're always happy to discuss new features!

Bugs 🐛

Please open an issue to report a bug. Try to be as detailed as possible, and always include:

  • The Python version you're using.
  • The logot version you're using.
  • Steps to reproduce.

Please report vulnerabilities privately via GitHub Security. Security issues will be fixed as soon as possible. 💪

New features and changes 🏗️

For non-trivial features and changes, please open an issue first to discuss the work! This will make it easier to understand and (hopefully) accept your contribution.

Developing 🤓

logot is developed using Poetry, an excellent Python packaging and dependency management tool. Make sure Poetry is installed and up-to-date before developing logot!

  1. Fork the logot GitHub project.

  2. Clone the repository locally:

    git clone git@github.com:your-username/logot.git
cd logot

  3. Install dependencies and activate your project:

    poetry install --all-extras
poetry shell

  4. Create a new branch:

    git checkout -b awesome-thing

  5. Implement your changes! Don't worry about keeping a clean commit history, as your PR will be squashed when merged into logot! 😅

  6. Add tests and documentation. Please see our build and test workflow for all required lints and checks, including:

  7. Commit and push your changes:

    git add .
git commit -m 'Added awesome thing'
git push origin awesome-thing

  8. Open a pull request to submit your changes to logot. Please include a good title and description, since this will become the permanent commit message when merged into logot! 🚀