Skip to content

Latest commit

 

History

History
29 lines (15 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

29 lines (15 loc) · 1.54 KB
Raw

How to contribute to MaveDB

All contributors should familiarize themselves with the Code of Conduct.

Reporting a bug

  • Check and see if the bug has already been reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new issue. Be sure to include a title and clear description with as much relevant information as possible. If you are having a problem uploading data, include a sample of your dataset.

Contributing patches to fix bugs or add new features

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Link to any relevant issues in the Issue Tracker if applicable.

  • Include documentation and test cases with your new feature.

  • Please be ready to respond to feedback and questions from the maintainers in the pull request.

Contributing to the documentation

  • Open a new GitHub pull request with your documentation changes. MaveDB's documentation is written in reStructuredText and built using Sphinx.

  • Summarize the documentation changes in the PR description.

  • Please be mindful of the size of images (such as screenshots) that you want to include.

Thanks you for reading!