Skip to content

Latest commit

 

History

History
115 lines (74 loc) · 3.24 KB

CONTRIBUTING.md

File metadata and controls

115 lines (74 loc) · 3.24 KB
Raw

Contributing to Kolkra-NG

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

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/m1n0rm1n3r/Kolkra-NG/issues

If you are reporting a bug, please include detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement a fix for it.

Implement Features

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

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/m1n0rm1n3r/Kolkra-NG/issues.

If you are proposing a new feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome!

Get Started!

Ready to contribute? Here's how to set up Kolkra-NG for local development. Please note this documentation assumes you already have poetry and Git installed and ready to go.

  1. Fork the Kolkra-NG repo on GitHub.

  2. Clone your fork locally:

cd <directory_in_which_repo_should_be_created>
git clone [email protected]:YOUR_NAME/Kolkra-NG.git
  1. Now we need to install the environment. Navigate into the directory
cd Kolkra-NG

If you are using pyenv, select a version to use locally. (See installed versions with pyenv versions) (Kolkra-NG was built for Python 3.10 or later.)

pyenv local <x.y.z>

Then, install and activate the environment with:

poetry install
poetry shell
  1. Install pre-commit to run various checks at commit time:
poetry run pre-commit install
  1. Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

  1. When you're done making changes, check that your changes pass the linting checks.
make check
  1. Test all features you added or changed in an isolated environment to help catch any bugs.

Create a configuration file at config.toml. config.EXAMPLE.toml provides a template and explanation for what fields you should provide.

You will also need to set up MongoDB, whether on your local machine or through a cloud provider like Atlas. If you have Docker installed on your machine, you can quickly spin up an ephemeral MongoDB instance with an included Makefile script.

make start-mongo
  1. Commit your changes and push your branch to GitHub:
git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature
  1. Submit a pull request through the GitHub website.

Conventional Commits

Contributors are strongly encouraged, but not required, to follow Conventional Commits in your commit messages. If you use Visual Studio Code (or VSCodium), you should use the Conventional Commits extension to help you format your commit messages properly.