Included contributing section into README: #13
Conversation
(1) requirements for PRs (2) example data upload
|
Great! Maybe the PR requirements could also be in form of a pull_request_template.md, to be consistent with the other repo and that these checks will automatically appear when submitting a PR? |
|
@JuliaKukulies: Nice idea! I added a PR template based on your link! |
|
@JuliaKukulies : Would you like to proceed the review? |
There was a problem hiding this comment.
Hey @fsenf, two small comments from me (see below). Otherwise it looks good, also with the PR template. Thanks for adding this one! I hope it is not an overkill of instructions now, but I think it is useful to have this PR check list to facilitate the contribution and review.
README.md
Outdated
| * **with your suggestions to change the documentation elements**, e.g. `index.rst` | ||
| * please care that sphinx-based rendering is still working correctly | ||
|
|
||
| * **or with combination of both** |
There was a problem hiding this comment.
I think this line would slightly confuse me, should there be separate pull requests or is it OK to have the addition of the notebook and changes to index.rst in one?
README.md
Outdated
| * please check if your notebook is running in the recommended standard conda enviroment [see here]((docs/RunningTutorials.md) and update the [list of required python packages](./requirements.txt) if needed | ||
|
|
||
| * **with your suggestions to change the documentation elements**, e.g. `index.rst` | ||
| * please care that sphinx-based rendering is still working correctly |
There was a problem hiding this comment.
Maybe provide a link on how to check this or in general how jupyter notebook works with Sphinx (e.g. https://docs.readthedocs.io/en/stable/guides/jupyter.html) ?
…sphinx-based rendering of our tutorials
|
@JuliaKukulies : Thanks for your suggestions! I removed the bullet that confused you & I added a small docu on how to run sphinx-based rendering locally. Please have a look ... |
|
@JuliaKukulies : PR ready to merge? What do you think? |
|
Sorry for delaying this @fsenf, but I am happy with it now and would say go ahead and merge! |
|
@JuliaKukulies : Great, and be convinced that I am always slower than you ;-) |
Based on the discussions in PR #10 & issue #8, I added a small description to our README containing:
(1) requirements for PRs
(2) example data upload