Skip to content

contributing.md

Latest commit

 

History

History
37 lines (27 loc) · 1.59 KB

contributing.md

File metadata and controls

37 lines (27 loc) · 1.59 KB

Contributing to pymatviz

Community contributions are very welcome! Whether it's reporting a bug, proposing a feature, or submitting code, your input is valuable.

Reporting Issues & Requesting Features

  • Use the GitHub Issues to report bugs or suggest new features.
  • For bug reports, please include:
    • A clear description of the issue and the package version you are using.
    • Steps to reproduce the bug (including a minimal code example).
    • What you expected vs. what actually happened.
    • Any relevant error messages or tracebacks.

Contributing Code via Pull Requests

We strive for a quick turnaround on pull requests (PRs) for bug fixes and new features.

To ensure code quality and consistency, please install and set up pre-commit hooks before making commits:

pip install pre-commit
pre-commit install
git commit -m "commit message" # this will trigger the pre-commit hooks

Workflow

  1. Fork the repository.
  2. Create a new branch for your changes (git checkout -b your-feature-name).
  3. Make code changes.
  4. Add tests for any new functionality and fixes.
  5. Update docs if necessary.
  6. Push your branch to your fork (git push origin your-feature-name).
  7. Open a Pull Request against the main branch of janosh/pymatviz.
  8. Your PR must pass all automated checks (tests, linting, code coverage) that run in our GitHub Actions workflows before it can be merged.

By contributing, you agree that your contributions will be licensed under the same MIT License that covers the project. Thanks for contributing to pymatviz!