Skip to content

Commit 0e5dd6f

Browse files
committed
format CONTRIBUTE.md
1 parent 87db279 commit 0e5dd6f

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Thank you for contributing to RMG-Py! Please take a moment to review our guidelines:
44

5-
#### **Did you find a bug? Do you want to see a new feature?**
5+
### **Did you find a bug? Do you want to see a new feature?**
66

77
* Please open an Issue to the corresponding repository:
88
* [RMG-Py](https://github.com/ReactionMechanismGenerator/RMG-Py/issues): For functionality of the RMG and Arkane software packages
@@ -11,7 +11,7 @@ Thank you for contributing to RMG-Py! Please take a moment to review our guideli
1111

1212
* For more detailed information on submitting a bug report and creating an issue, visit our [reporting guidelines](https://example.com).
1313

14-
#### **Did you write code that fixes a bug, or adds a new feature?**
14+
### **Did you write code that fixes a bug, or adds a new feature?**
1515

1616
* Open a new GitHub PR to merge into the main branch. Make sure the PR clearly describes the problem + solution. If applicable, include the relevant issue.
1717

@@ -23,11 +23,10 @@ Thank you for contributing to RMG-Py! Please take a moment to review our guideli
2323
* In the `test/regression` folder, create a new folder with a relevant name, and copy the RMG-Py simulation input file in this folder. Include this new folder in your PR.
2424
* In `.github/workflows/CI.yml`, edit the two lists of regression tests in the `Regression Tests - Execution` and `Regression Tests - Compare to Baseline` steps to add the name of your folder. Be sure to follow BASH syntax.
2525

26-
> ** Warning **
27-
> This will __fail__ CI because of directory not found errors. This is because the baseline files used for comparison in the regression tests do not exist yet. Your PR will need to be merged by bypassing branch protection restrictions.
26+
* > Warning: This will __fail__ CI because of directory not found errors. This is because the baseline files used for comparison in the regression tests do not exist yet. Your PR will need to be merged by bypassing branch protection restrictions.
2827
2928

30-
#### **Do you want to contribute to the documentation?**
29+
### **Do you want to contribute to the documentation?**
3130

3231
* Documentation is [hosted here](http://reactionmechanismgenerator.github.io/RMG-Py/) using [Sphinx](https://www.sphinx-doc.org/en/master/).
3332

@@ -37,11 +36,11 @@ Thank you for contributing to RMG-Py! Please take a moment to review our guideli
3736

3837
* Please test the documentation on a local build (e.g., via `make html` in the `documentation` directory) before pushing changes.
3938

40-
#### **Do you have questions?**
39+
### **Do you have questions?**
4140

4241
* Email us at rmg_dev@mit.edu.
4342

44-
#### **Best practices for PRs**
43+
### **Best practices for PRs**
4544

4645
* Rebase to the main branch before working, to avoid merge conflicts.
4746

0 commit comments

Comments
 (0)