Skip to content

Contributing and getting help

If you run into any problems using this package, or if you have a question, suggestion or feedback, then please raise an issue on GitHub.

The Materials Consortia is very open to contributions across all of its packages. This may be anything from simple feedback and raising new issues to creating new PRs.

If you are interested in contributing but don't know where to begin, some issues have been marked with the good first issue label, typically where an isolated enhancement has a concrete suggestion. Simply add a comment under an issue if you are interested in tackling it!

Recommendations for setting up a development environment for this package can be found in the Installation instructions.

More broadly, if you would like to ask questions or contact the consortium about creating an OPTIMADE implementation for a new database, then please read the relevant "get involved" section on the OPTIMADE website.