Skip to content

Contributing to kmhelpers

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: - Star the project - Mention the project at local meetups and tell your friends/colleagues - Refer this project in your project's readme

Table of Contents

I Have a Question

If you want to ask a question, we assume that you have read the available Documentation.

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open an Issue.
  • Provide as much context as you can about what you're running into.
  • Provide your OS, Python version, conda version, kmhelpers version, and kmindex version, depending on what seems relevant.

We will then take care of the issue as soon as possible.

I Want To Contribute

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license (GPL-3.0-only).

Reporting Bugs

Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

  • Make sure that you are using the latest version.
  • Determine if your bug is really a bug and not an error on your side e.g. using an incompatible environment or version of kmindex (Make sure that you have read the documentation. If you are looking for support, you might want to check this section).
  • Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
  • Collect information about the bug:
  • Stack trace (Traceback)
  • OS, platform and version (Linux x86_64, macOS Intel, macOS Apple Silicon)
  • Python version and conda environment details (conda info, pip show pykmhelpers)
  • kmhelpers version (kh --version)
  • Version of kmindex, kmtricks, and ntCard (kmindex --version, kmtricks --version, ntcard --version)
  • Possibly your input (JSONL sample list, YAML config) and the output
  • If kmhelpers crashed, attach the dump file (kmhelpers_<timestamp>.dump) written to your working directory
  • Can you reliably reproduce the issue? And can you also reproduce it with older versions?

How Do I Submit a Good Bug Report?

You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to kmhelpers@groupes.renater.fr.

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open an Issue. (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
  • Explain the behavior you would expect and the actual behavior.
  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes the command you ran and the relevant input files or configuration. For good bug reports you should isolate the problem and create a reduced test case.
  • Provide the information you collected in the previous section.

Once it's filed:

  • The project team will label the issue accordingly.
  • A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as needs-repro. Bugs with the needs-repro tag will not be addressed until they are reproduced.
  • If the team is able to reproduce the issue, it will be marked needs-fix, as well as possibly other tags (such as critical), and the issue will be left to be implemented by someone.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for kmhelpers, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

Before Submitting an Enhancement

  • Make sure that you are using the latest version.
  • Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
  • Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
  • Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset.

How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
  • Explain why this enhancement would be useful to most kmhelpers users. You may also want to point out other projects that solved it better and which could serve as inspiration.

Your First Code Contribution

Setting up the development environment

  1. Fork and clone the repository: 

    git clone https://github.com/<your-username>/kmhelpers
cd kmhelpers

  2. Create the conda environment and install kmhelpers in editable mode: 

    conda env create -f conda/environment.yml -p ./.env
conda activate ./.env
pip install -e ".[dev]"

  3. Run the test suite to verify everything is working: 

    pytest

Workflow

  • Create a feature branch from main: git checkout -b feature/my-feature
  • Make your changes and add tests under pykmhelpers/tests/
  • Ensure all checks pass before opening a pull request: 
    black pykmhelpers          # format
flake8 pykmhelpers         # lint
mypy pykmhelpers           # type-check
pytest                     # tests
  • Open a pull request against the main branch.

Improving The Documentation

The documentation is built with MkDocs Material and hosted at https://sebllns.github.io/kmhelpers/.

To preview the docs locally:

pip install -e ".[docs]"
mkdocs serve

Source files live under docs/. Please keep the documentation consistent with any code changes you make.

Styleguides

Code Style

  • Formatter: Black with line-length = 88. Run black pykmhelpers before committing.
  • Linter: Flake8. Run flake8 pykmhelpers before committing.
  • Type hints: encouraged. Run mypy pykmhelpers to check.
  • Import order: isort with the black profile.

Commit Messages

  • Use the imperative mood: "Add feature", not "Added feature".
  • Keep the subject line under 72 characters.
  • Reference related issues where applicable: Fix #42 — ….
  • Notable changes should be reflected in CHANGELOG.md under the relevant version section.

Join The Project Team

If you are interested in becoming a regular contributor or maintainer, reach out by opening an issue or contacting us at kmhelpers@groupes.renater.fr.

Attribution

This guide is based on the contributing-gen. Make your own!

thank PPenloglou-WMF, CC BY-SA 3.0, via Wikimedia Commons