codecheckers / codecheck

R package assistant for conducting a CODECHECK
MIT License
10 stars 3 forks source link

Instructions in README #59

Open langtonhugh opened 2 months ago

langtonhugh commented 2 months ago

Currently the repo's README file does not have any instructions for first time codecheckers. Things that might be useful:

nuest commented 2 months ago

In lack of another better documentation, we could also reference the community process documentation at https://codecheck.org.uk/guide/community-workflow That document is currently written independent of the R package.

@langtonhugh Would you be fine with focusing the content in the README on using the R package for a check? One sentence on what the manifest entails is definitely a good idea.

I can in parallel try to improve other documents to better include the content that better fits elsewhere/that we would like to reference from the README.