Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (27 loc) · 2.73 KB

CONTRIBUTING.md

File metadata and controls

44 lines (27 loc) · 2.73 KB

Contributing to LabMaster

First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to LabMaster, which is hosted in the LabMaster GitHub repository. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for LabMaster. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for LabMaster, including completely new features and minor improvements to existing functionality.

  • Ensure the enhancement was not already suggested by searching on GitHub under Issues.
  • If you find an open issue addressing the idea, add relevant comments to that issue.
  • If you don't find an open issue, you can open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or test case demonstrating the functionality.

Pull Requests

  • When you're ready to contribute with code, create a fork of the repository.
  • Clone your fork and create a new branch from main for your work.
  • Commit your changes and push your branch to your fork on GitHub.
  • Open a pull request to the main branch of the original repository.
  • Ensure your pull request description clearly describes the problem and solution. Include the relevant issue number if applicable.

Coding Standards

  • Follow the existing coding style.
  • Write clear, concise comments and documentation.
  • Include tests that prove your code works and that your changes don't break existing code.

Code of Conduct

This project adheres to a Contributor Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to minniti@ipmc.cnrs.fr.

Thank You!

Thank you for considering contributing to LabMaster! Together we can make this project better for the community.