You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6-7Lines changed: 6 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
Thank you for contributing to RMG-Py! Please take a moment to review our guidelines:
4
4
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?**
6
6
7
7
* Please open an Issue to the corresponding repository:
8
8
*[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
11
11
12
12
* For more detailed information on submitting a bug report and creating an issue, visit our [reporting guidelines](https://example.com).
13
13
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?**
15
15
16
16
* 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.
17
17
@@ -23,11 +23,10 @@ Thank you for contributing to RMG-Py! Please take a moment to review our guideli
23
23
* 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.
24
24
* 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.
25
25
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.
28
27
29
28
30
-
####**Do you want to contribute to the documentation?**
29
+
### **Do you want to contribute to the documentation?**
31
30
32
31
* Documentation is [hosted here](http://reactionmechanismgenerator.github.io/RMG-Py/) using [Sphinx](https://www.sphinx-doc.org/en/master/).
33
32
@@ -37,11 +36,11 @@ Thank you for contributing to RMG-Py! Please take a moment to review our guideli
37
36
38
37
* Please test the documentation on a local build (e.g., via `make html` in the `documentation` directory) before pushing changes.
39
38
40
-
####**Do you have questions?**
39
+
### **Do you have questions?**
41
40
42
41
* Email us at rmg_dev@mit.edu.
43
42
44
-
####**Best practices for PRs**
43
+
### **Best practices for PRs**
45
44
46
45
* Rebase to the main branch before working, to avoid merge conflicts.
0 commit comments