Skip to content

Contributing to MACH2 and MACH2-Viz

We welcome all helpful contributions to improving MACH2 and MACH2-Viz. Contributors can help in the following ways:

  • Adding your dataset visualizations to the MACH2-Viz homepage. To learn how to include your dataset in the homepage, see here.
  • Identifying and/or fixing bugs and typos
  • Writing tutorials and/or blog posts
  • Proposing/developing new features

How to Ask for Help

  • Raise issues regarding either MACH2, MACH2-Viz or the documentation. Issues can include bugs and errors with installation and usage, or just suggestions for new features. Before raising an issue, please make sure of the following:
    • Double check that your issue isnt already addressed in the documentation on this website.
    • Ensure the dependencies and version are up to date.
    • Check if an issue has already been posted that addresses your concern.

Community Guidelines

Using Appropriate Language

In commit messages, docs, and issues, we expect that contributors create a positive environment by:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Focusing on what is best for the community
  • Showing empathy towards other community members