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

Define best practises that we're looking for #28

Open
npscience opened this issue Jun 15, 2018 · 0 comments
Open

Define best practises that we're looking for #28

npscience opened this issue Jun 15, 2018 · 0 comments

Comments

@npscience
Copy link

Can we generate a simple list of best practises we're looking for? We're interested to investigate examples in the eLife corpus.

My starting list, for feedback and discussion:

  • code is shared by researcher via a repository
  • this repo URL still resolves
    and in this repo:
  • license is defined
  • citation file
  • readme
  • contributing guidelines [is this an optional extra?]
  • evidence that code has been reviewed / outputs have been reproduced [is this a next step best practise for research code?]
  • test coverage ??
  • commenting coverage ?? [how else to measure how well-documented the code is?]
    plus:
  • archived deposit that relates to version of record publication --> particularly if original repo URL no longer resolves
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

1 participant