Contributing#

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

Bug reports#

When reporting a bug please include:

  • Your operating system name and version.

  • Any details about your local setup that might be helpful in troubleshooting.

  • Detailed steps to reproduce the bug.

Documentation improvements#

MoDaCor could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and similar resources.

Feature requests and feedback#

The best way to send feedback is to file an issue at BAMresearch/modacor#issues.

If you are proposing a 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 code contributions are welcome.

Development#

To set up modacor for local development:

  1. Fork modacor (look for the “Fork” button).

  2. Clone your fork locally:

    git clone git@github.com:YOURGITHUBNAME/modacor.git

  3. Create a branch for local development:

    git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  4. When you’re done making changes run all the checks and docs builder with tox in one command:

    tox

  5. Commit your changes and push your branch to GitHub:

    git add .
git commit -m "fix: describe the concrete change"
git push origin name-of-your-bugfix-or-feature

  6. Submit a pull request through the GitHub website.

Pull request guidelines#

If you need some code review or feedback while you’re developing the code just make the pull request.

For merging, you should:

  1. Include passing tests (run tox).

  2. Update documentation when there’s new API, functionality, etc.

  3. Use a semantic commit prefix such as fix:, enh:, feat:, or docs: when the change should appear in release notes.

  4. Add yourself to AUTHORS.md.

Releases and changelog#

Do not edit CHANGELOG.md manually for normal feature or bug-fix PRs. After changes land on main, the GitHub Actions release-preparation workflow opens a separate release PR with the generated changelog and version bumps. Review and merge that release PR like any other change.

The release workflow only tags and publishes a version after the generated release PR has been merged into main.

Tips#

To run a subset of tests:

tox -e envname -- pytest -k test_myfeature

To run all the test environments in parallel:

tox -p auto