1
1
GitHub Pull Request and Review Process
2
2
======================================
3
3
4
+ Here, we describe the pull request and review process for bring new tutorial notebooks into the SimPEG user tutorials repository.
5
+
4
6
Requirements Checklist
5
7
----------------------
6
8
7
- The following is a useful checklist for determining whether a new tutorial notebook follows our guidelines :
9
+ The following is a useful checklist for determining whether the tutorial notebook has satisfied formatting and structure requirements :
8
10
9
11
* ** The introduction is complete:**
10
12
* Title and author added to notebook
@@ -13,9 +15,48 @@ The following is a useful checklist for determining whether a new tutorial noteb
13
15
* Summary paragraph describing the tutorial has been added
14
16
* Learning objectives have been listed
15
17
* Hyperlinks to other tutorial notebooks added if necessary
16
- * ** For each section:**
17
- * Short summary of what is being done
18
- * Newly introduced functionality is explained or a link is provided to a relevant notebook
18
+ * ** For sections and subsections:**
19
+ * A header and short summary of what is being done
19
20
* Links to API documentation added for all classes and functions that are used
20
- * Data, models, etc... are plotted appropriately
21
- * Coding cells have been linted according to the [style guides](https://docs.simpeg.xyz/latest/content/getting_started/contributing/code-style.html).
21
+ * Newly introduced functionality is explained or links provided to relevant notebooks
22
+ * All figures are legible and rendered appropriately
23
+ * Coding cells have been linted according to the [ style guides] ( https://docs.simpeg.xyz/latest/content/getting_started/contributing/code-style.html ) .
24
+
25
+ Stages of a Pull Request
26
+ ------------------------
27
+
28
+ When you are ready to submit your tutorial notebook review, you will make a
29
+ GitHub pull request (PR). If your pull request is not ready for a final review,
30
+ but you require feedback, please mark it as a draft pull request. Once you
31
+ feel the pull request is ready for a final review, you can convert the draft PR to
32
+ an open PR by selecting the `` Ready for review `` button at the bottom of the page.
33
+
34
+ Once a pull request is in `` open `` status and you are ready for review, please
35
+ ping `` dccowan `` and `` santisoler `` in a github comment to
36
+ request a review. At minimum for a PR to be eligible to merge, we look for
37
+
38
+ - Structure and formatting requirements are observed.
39
+ - The notebooks runs properly using the latest release of SimPEG.
40
+ - All reviewer comments (if any) have been addressed.
41
+ - A developer approves the PR.
42
+
43
+ After all these steps are satisfied, a `` @simpeg/simpeg-admin `` will merge your
44
+ pull request into the main branch (feel free to ping one of us on Github).
45
+
46
+ This being said, all SimPEG developers and admins are essentially volunteers
47
+ providing their time for the benefit of the community. This does mean that
48
+ it might take some time for us to get your PR.
49
+
50
+ Merging a Pull Request
51
+ ----------------------
52
+
53
+ The `` @simpeg/simpeg-admin `` will merge a Pull Request to the ` main ` branch
54
+ using the `Squash and Merge
55
+ < https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-commits > `_
56
+ strategy: all commits made to the PR branch will be _ squashed_ to a single
57
+ commit that will be added to ` main ` .
58
+
59
+ SimPEG admins will ensure that the commit message is descriptive and
60
+ comprehensive. Contributors can help by providing a descriptive and
61
+ comprehensive PR description of the changes that were applied and the reasons
62
+ behind them. This will be greatly appreciated.
0 commit comments