Skip to content

Commit b309c86

Browse files
authored
Update CONTRIBUTING.md
add note on to-dos for new sumodules, they're getting overlooked almost always..
1 parent b865f0d commit b309c86

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

CONTRIBUTING.md

+2
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ First, if the PR is directly related to an already existing issue (which is no P
3030

3131
Please make sure to select the correct base branch (`master` vs. `maintenance_x.x.x`) for your PR.
3232

33+
If your PR is adding a new submodule, please go through the [to-do items for new submodules in the wiki](https://github.com/obspy/obspy/wiki/How-to%3A-add-a-new-submodule).
34+
3335
If you want to request an automated build of ObsPy's API docs for your PR, simply include the magic string `+DOCS` somewhere in the PR's comments. Once finished, the docs build will show up in the PR's review/commit status section alongside the results from Continuous Integration (PR docs builds can be looked up [here](http://docs.obspy.org/pull-requests/)).
3436

3537
If any specific networking modules should be tested for the PR, e.g. when proposing changes to the FDSN client module, please include a magic string like e.g. `+TESTS:clients.fdsn` somewhere in the PR's comments. Multiple modules can be comma separated (e.g. `+TESTS:clients.fdsn,clients.iris`) or put in separate `+TESTS:...` strings, which will be accumulated across all of the PR's comments. To run *all* modules' test suites, include `+TESTS:ALL` somewhere in a comment.

0 commit comments

Comments
 (0)