Skip to content

Contributing to imxInsights

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

All types of contributions are encouraged and valued!!! 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.

Development

Setup environment

We use Hatch to manage the development environment and production build. Ensure it's installed on your system.

hatch env create

Local environments

Make sure the IDE is using the created environment.

Hatch configuration:

Configuration for Hatch itself is stored in a config.toml file located by default in one of the following platform-specific directories.

Platform Path
macOS ~/Library/Application Support/hatch
Windows %USERPROFILE%\AppData\Local\hatch
Unix $XDG_CONFIG_HOME/hatch (the XDG_CONFIG_HOME environment variable default is ~/.config)

If you wanted to store virtual environments in a .venv directory within your home directory, you could specify the following in the config.toml:

[dirs.env]
virtual = ".venv"

Run unit tests

You can run all the tests with:

hatch run test

Format the code

Execute the following command to apply linting and check typing:

hatch run lint

Serve the documentation

You can serve the Mkdocs documentation with:

hatch run docs-serve

Pre-commit Hooks

We use pre-commit to automatically run linters and formatters before each commit to maintain consistent code quality.

Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line
  • Consider starting the commit message with an applicable emoji: https://gitmoji.dev/

Publish a new version

When you push the tag on GitHub, the workflow will automatically publish it on PyPi and a GitHub release will be created as draft.

We should bump the version manually. Additionally, we need to implement an automatic build number increment for every merge into the master branch.

Bump version

You can bump the version, create a commit and associated tag with one command:

hatch version patch

hatch version minor

hatch version major

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to <>.