Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

42 lines (28 loc) · 1.9 KB
Raw

How to contribute to LipidLynxX

Did you find a bug?

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. If possible, use the relevant bug report templates to create the issue.

Did you write a patch that fixes a bug?

Open a new GitHub pull request with the patch. Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Did you fix whitespace, format code, or make a purely cosmetic patch?

Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of LipidLynxX will generally not be accepted. LipidLynxX source code use code style Black for all python codes. JSON configurations are formatted by Visual Studio Code / PyCharm editor.

Do you intend to add a new feature or change an existing one?

Suggest your proposals by submitting a feature request issue in the issue tracker.

Please indicate if you are proposing feature request to detailed fields:

  • You want LipidLynxX to support of input lipid notation style from unspoorted software/ database
  • You want LipidLynxX to add connection to databases
  • You want LipidLynxX to export specific format
  • You want some functions in LipidLynxX API/GUI/command-line that currently is not avaliable.

Do you have questions about the source code?

Ask any question about how to use LipidLynxX in issue tracker.

Thanks!

SysMedOs Team

Adapted from https://github.com/rails/rails/blob/master/CONTRIBUTING.md