Contributing Guidelines

Welcome! Nanomesh is an open-source project that aims to streamline segmenting image data and generating 2D or 3D meshes. If you’re trying Nanomesh with your data, your experience, questions, bugs you encountered, and suggestions for improvement are important to the success of the project.

We have a Code of Conduct, please follow it in all your interactions with the project.

Submitting changes

When contributing to this repository, please first discuss the change you wish to make via an issue with the owners of this repository before making a change.

Contributions can come in the form of:

  • Bug fixes

  • New features

  • Improvement of existing code

  • Updates to the documentation

  • … ?

We use the usual GitHub pull-request flow. For more info see GitHub’s own documentation.

Typically this means:

  1. Forking the repository and/or make a new branch

  2. Making your changes

  3. Make sure that the tests pass and add your own

  4. Update the documentation is updated for new features

  5. Pushing the code back to Github

  6. Create a new Pull Request

One of the code owners will review your code and request changes if needed. Once your changes have been approved, your contributions will become part of duqtools. πŸŽ‰


Check out the Development Notes to help get started with development.