n-kall / priorsense

priorsense: an R package for prior diagnostics and sensitivity
https://n-kall.github.io/priorsense/
GNU General Public License v3.0
53 stars 5 forks source link

Consider adding a contribution guide #14

Open rantahar opened 1 year ago

rantahar commented 1 year ago

Here is an example from tidyverse: https://dplyr.tidyverse.org/CONTRIBUTING.html

Tidyverse also has a contribution guide on its project site here: https://www.tidyverse.org/contribute/. It might make sense to have this in just one place for your teams projects, rather than having one for each project.

Neither of these mention a license. I would add something like "Your contribution is licensed under GPL 3.x".

It's a good idea to maintain a unified style and structure to the code. This helps development in the future. You can mention these in the contribution guide, but be mindful that these can increase the barrier to contribute. So in a smaller project you might leave these out and mention them when reviewing a pull request or do them after merging.

The more you add to the guide, the less work you need to do yourself (because the contributor is expected to do it).