Contributing to metadynminer3d development

This is a guide to help you to contribute to metadynminer3d development by:

1. Reporting a bug or requesting a new feature in an issue.
2. Suggesting a change via a pull request.

Issues

If you are registered at GitHub, you can report a bug or request a new feature in an issue. When filing the issue, please, include a minimal example demonstrating the problem, and, if possible, suggest a solution.

If the issue is demonstrated on external data, make sure it is available.

Try to write the code to be easy to understand and use comments to locate the problem and to indicate expected functionalities. Remove all code not related to the problem.

Make sure that the issue is related to metadynminer3d and not to metadynminer.

If you are not registered at GitHub, you can contact the developers by e-mail.

Pull requests

To contribute to metadynminer3d, make sure that your code change fits to metadynminer3d, and not metadynminer.

To contribute a change to metadynminer3d, please follow these steps:

1. Create a branch in git and make your changes.
2. Push branch to GitHub and issue pull request (PR).
3. Discuss the pull request.
4. Iterate until either we accept the PR or decide that it’s not a good fit for metadynminer3d.

Metadynminer3d and its pull requests are automatically checked by GitHub actions and Appveyor. Make sure that no errors are returned for your version of the code.