Skip to content

Commit 87d1ad0

Browse files
committed
Modify CONTRIBUTING.md and lipid test documentation
1 parent a61161d commit 87d1ad0

2 files changed

Lines changed: 8 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Thank you for considering contributing to CoreMS! We appreciate your interest in
55
## Table of Contents
66

77
- [Getting Started](#getting-started)
8+
- [Versioning](#versioning)
89
- [Merge Request Checklist](#merge-request-checklist)
910
- [Code Style](#code-style)
1011
- [Issue Reporting](#issue-reporting)
@@ -19,9 +20,12 @@ To get started with contributing to CoreMS, please follow these steps:
1920
3. Install the necessary dependencies. Refer to the [README](./README.md) for detailed installation instructions.
2021
4. Make your changes or additions.
2122
5. Test your changes thoroughly.
22-
6. Re-render documenation using the following `pdoc --o docs --d numpy corems`. Note that pdoc versioning is part of the requirements-dev.txt.
23-
7. Commit your changes and push them to your forked repository. Reference your original issue in your commits (i.e. closes #23)
24-
8. Submit a merge request to the main CoreMS repository and select an appropriate reviewer for the changes. Note the merge request checklist below that will be checked before each merge into the master branch. See the merge request checkliist
23+
6. Commit your changes and push them to your forked repository. Reference your original issue in your commits (i.e. closes #23)
24+
7. Submit a merge request to the main CoreMS repository and select an appropriate reviewer for the changes. Note the merge request checklist below that will be checked before each merge into the master branch. See the merge request checklist
25+
26+
## Versioning
27+
28+
We strive to use semantic versioning. To bump a new version and regenerate documentation, use one of the following make commands (according to version number) `make major`, `make minor`, or `make patch`. This should accompany each PiPy release.
2529

2630
## Merge Request Checklist
2731

tests/test_wf_lipidomics.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ def test_lipidomics_workflow():
128128
myLCMSobj.find_c13_mass_features()
129129
assert len(myLCMSobj.mass_features) == 130
130130

131-
# Perform a molecular search on a few of the mass features
131+
# Perform a molecular search on all of the mass features' ms1 peaks
132132
mol_form_search = SearchMolecularFormulasLC(myLCMSobj)
133133
mol_form_search.run_mass_feature_search()
134134

0 commit comments

Comments
 (0)