Contributing to ArviZ

As a scientific, community-driven, open source software project, ArviZ welcomes contributions from interested individuals or groups. These guidelines are provided to give potential contributors information to make their contributions compliant with the conventions of the ArviZ project, and maximize the probability of such contributions to be merged as quickly and efficiently as possible.

Even though contributing code or documentation by sending pull requests on the main ArviZ GitHub repository is the most common way of contributing and therefore this guide dedicates many resources to these, ArviZ welcomes any kind of contribution. As a clear proof, you can become a core contributor and participate in ArviZ governance without having contributed code to ArviZ. All contributions to ArviZ, either on its codebase, its documentation, or its community are valuable and we really appreciate your help.

Tip

Contact us on Gitter if you want to contribute to the project but you are not sure where you can contribute or how to start.

Below we list some examples of contributions that might serve as inspiration.

• Submitting issues related to bugs or desired enhancements. Check the details at Issue reports.

• Translate our website to languages other than English. Check the details at Translate ArviZ website and documentation

• Fixing outstanding issues (bugs) with the existing codebase. They range from low-level software bugs to higher-level design problems.

• Contributing or improving the documentation (docs) or examples (arviz/examples).

• Help users submitting issues by making sure their issue is clear and/or providing temporal workarounds for them. Check the details at Issue Triaging

• Review Pull Requests ensuring contributions are well tested and documented, that documentation renders correctly and has no typos or mistakes. Check the details at Review PRs

• Adding new or improved functionality to the existing codebase.

Further information on how to contribute to ArviZ can be found on these specific pages:

Contribution types overview

• Issue reports
  • Minimal reproducible example
  • Sharing error tracebacks
• Translate ArviZ website and documentation
  • Currently active translations
  • Manage translations
• Issue Triaging
  • How to subscribe to ArviZ issues
  • Triage guidelines and suggestions
• Outreach
• Review PRs
• Contributing code via pull requests
  • Steps before starting work
  • Development process - summary
  • Code Formatting
• Docstring formatting and type hints
  • Documentation for user facing methods