Simplify contributors guide - Githubissues

very-good-science / our-handbook

This is a Jupyter-Book template for a research group handbook

https://very-good-science.github.io/our-handbook/

Other

7 stars 36 forks source link

Simplify contributors guide #59

Closed jatonline closed 2 years ago

jatonline commented 2 years ago

Description

Simplify the process of contributing to the handbook by making the contributors guide clearer

Emphasise changing or branching from the develop branch
Make a commit before creating a draft pull request
Make calls-to-action separate bullet points
Make use of seealso admonitions for background reading
Improve title of the style guide

Partly addresses #28

Checklist (contributor)

[x] Marked as draft
[x] Linked to issue
[x] Filled in description
[x] Gave this Pull Request a descriptive title

Checklist (maintainer)

[x] Built site locally.
[x] Changes are as discussed in issue.
[x] The PR is to the Our Handbook develop branch
[x] New pages are linked in the TOC/navigation?
[x] Have we added the contributor to our all-contributors?
[x] One sentence per line

NatalieZelenka commented 2 years ago

Thanks so much for this James 🙌 I won't get a chance to look at this for a week or so, but I'm looking forward to pulling in these changes.

jatonline commented 2 years ago

As discussed via Slack. Thanks @NatalieZelenka for your help with this :)