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

docs: Add contributing guidelines and pull request template #184

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

MillironX
Copy link
Member

Adds the documentation so that others know how this repo functions and fits within the nf-core GitHub Actions space.

PR checklist

  • This comment contains a description of changes (with reason)
  • [NA] If you've fixed a bug or added code that should be tested, add tests!
  • Make sure your code lints (npm run lint)
  • Make sure your code passes formatting checks (npm run format:check)
  • [NA] Ensure the unit test suite passes (npm run test)
  • [NA] Ensure the integration test suite passes (act -j example-usage)
  • CHANGELOG.md is updated
  • [NA] README.md is updated

Copy link
Member

@ewels ewels left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great stuff, thanks!

I almost wonder if some of these docs should go in the readme or somewhere more findable, but no strong opinion, this is totally fine as well.

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

Successfully merging this pull request may close these issues.

2 participants