Adding some template and community documents #90
Conversation
Codecov Report
@@ Coverage Diff @@
## dev #90 +/- ##
=====================================
Coverage 91.7% 91.7%
=====================================
Files 7 7
Lines 687 687
=====================================
Hits 630 630
Misses 57 57Continue to review full report at Codecov.
|
| @@ -0,0 +1,25 @@ | |||
| # {{ cookiecutter.pipeline_slug }} Contributing Guidelines | |||
There was a problem hiding this comment.
{{ cookiecutter.pipeline_slug }} is just the final name of the pipeline (eg. rnaseq). So please do a find and replace to change to nf-core/{{ cookiecutter.pipeline_slug }} everywhere to include that base.
| 1. Fork the [nf-core/{{ cookiecutter.pipeline_slug }} repository](https://github.com/nf-core/{{ cookiecutter.pipeline_slug }}) and create your branch from `master`. | ||
| 2. If you've fixed a bug or added code that should be tested, add tests! | ||
| 3. Ensure the test suite passes (`nextflow run . -profile test,docker`). | ||
| 4. Make sure your code lints (`nf-core lint`). |
There was a problem hiding this comment.
For consistency with the above command, should be nf-core lint .
May be clearer to use <pipeline dir> instead of .?
| @@ -0,0 +1,11 @@ | |||
| **Is your feature request related to a problem? Please describe.** | |||
| A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | |||
There was a problem hiding this comment.
Maybe some more line breaks here would be good!
There was a problem hiding this comment.
That's exactly what I was saying to Fran and Orlando yesterday...
| - [ ] Ensure the test suite passes (`nextflow run . -profile test,docker`). | ||
| - [ ] Make sure your code lints (`nf-core lint .`). | ||
| - [ ] `CHANGELOG.md` is updated | ||
| - [ ] `README.md` is updated |
There was a problem hiding this comment.
Also the docs documentation is updated if relevant.
|
Great! 👍 |
closes #87