Skip to content

Latest commit

 

History

History
58 lines (37 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

58 lines (37 loc) · 1.89 KB

Contributing

This project is provided by GNS Science | Te Pū Ao to support the wider seismic hazard analysis community.

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

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/GNS-Science/solvis/issues.

If you are 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.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

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

The project has Markdown-based documentation, using MkDocs with mkdocstrings-python in the Google style.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/GNS-Science/solvis/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.

Get Started!