Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Instructions in README #59

Open
langtonhugh opened this issue Aug 30, 2024 · 1 comment
Open

Instructions in README #59

langtonhugh opened this issue Aug 30, 2024 · 1 comment

Comments

@langtonhugh
Copy link
Contributor

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

  • Guidelines on whether/when to fork the researcher's repository to the codechecker organisation (or not).
  • Where to execute codecheck::create_codecheck_files() in the file structure.
  • Definitions of things like 'manifest files'.
  • As per Template for codecheck.Rmd #58 , making the template RMD usable.
@nuest
Copy link
Member

nuest commented Sep 2, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants