search

carpentries / actions

GitHub Actions for use in Carpentries-style lessons
1 stars 8 forks source link

add a Contributing Guide #77

Closed tobyhodges closed 1 year ago

tobyhodges commented 1 year ago

Following a suggestion from @milanmlft after we were unable to merge his PR to fix #74, it would be good to include a CONTRIBUTING.md on this repository (and any others with similar security constraints) to describe the requirements for somebody's contributions to be acceptable. If this helps us avoid another situation where we cannot credit a contributor in the project history, I am all in favour.

zkamvar commented 1 year ago

Thank you @tobyhodges and @milanmlft for catching this oversight!

I will draft a document today that outlines contributing for this repository.

In short: all commits to this repository need to be verified. This can be done via SSH or GPG.

Additionally, I have a manual protocol for testing the actions before deployment (I would use automated testing, but I'm still unsure of how exactly to do that) that involves creating a new lesson (markdown: https://bit.ly/new-lesson-md R Markdown: https://bit.ly/new-lesson-rmd), pointing the actions to the correct branch, and then testing the proper component.

In this case, I would have created an R Markdown lesson and then updated ./github/carpentries/sandpaper-main.yaml to use @milanmlft's fork in the appropriate actions.