Collaboration - Githubissues

SoftDev4Research / 4OSS-lesson

The overall aim of these 4OSS in the shape of training materials will contribute to make research software FAIR.

https://SoftDev4Research.github.io/4OSS-lesson

Other

23 stars 22 forks source link

Collaboration #19

Closed orchid00 closed 6 years ago

orchid00 commented 6 years ago

Make clear what your project is and how to contribute, for new and existing collaborators

From Good enough practices for scientific computing

Create an overview of your project. (MUST INCLUDE)
Create a shared "to-do" list for the project. (MUST INCLUDE)
Decide on communication strategies. (MUST INCLUDE)
Make the license explicit. (will be part of the license recomendation)
Make the project citable (where to add?)

Except for the To-do list all of the above should be on the README file. I'm working on this

orchid00 commented 6 years ago

Improving CONTRIBUTING.md

[x] location root-project/CONTRIBUTING.md
[x] cheer: Give super nice welcome to contributors!
[x] introduction: Overview of the document
[x] how-to: cover the basics of expected contributions and times
[ ] style: Add a style guide

Examples

Other links

fmichonneau commented 6 years ago

Other examples:

pandas: https://pandas.pydata.org/pandas-docs/stable/contributing.html
dplyr: https://github.com/tidyverse/dplyr/blob/master/.github/CONTRIBUTING.md
octobox: https://github.com/octobox/octobox#contribute
scipy: https://github.com/scipy/scipy/blob/master/CONTRIBUTING.rst
sf package: https://github.com/r-spatial/sf#contributing
knitr: https://github.com/yihui/knitr/blob/master/.github/CONTRIBUTING.md
rmarkdown: https://github.com/rstudio/rmarkdown/blob/master/CONTRIBUTING.md

orchid00 commented 6 years ago

I will close this issue. Everyone who has a suggested resource please make a PR