diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b996b02..161f000 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,9 +1,9 @@ -# mk-kondo/mikrokondo: Contributing Guidelines +# phac-nml/mikrokondo: Contributing Guidelines Hi there! -Many thanks for taking an interest in improving mk-kondo/mikrokondo. +Many thanks for taking an interest in improving phac-nml/mikrokondo. -We try to manage the required tasks for mk-kondo/mikrokondo using GitHub issues, you probably came to this page when creating one. +We try to manage the required tasks for phac-nml/mikrokondo using GitHub issues, you probably came to this page when creating one. Please use the pre-filled template to save time. However, don't be put off by this template - other more general issues and suggestions are welcome! @@ -11,10 +11,10 @@ Contributions to the code are even more welcome ;) ## Contribution workflow -If you'd like to write some code for mk-kondo/mikrokondo, the standard workflow is as follows: +If you'd like to write some code for phac-nml/mikrokondo, the standard workflow is as follows: -1. Check that there isn't already an issue about your idea in the [mk-kondo/mikrokondo issues](https://github.com/mk-kondo/mikrokondo/issues) to avoid duplicating work. If there isn't one already, please create one so that others know you're working on this -2. [Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the [mk-kondo/mikrokondo repository](https://github.com/mk-kondo/mikrokondo) to your GitHub account +1. Check that there isn't already an issue about your idea in the [phac-nml/mikrokondo issues](https://github.com/phac-nml/mikrokondo/issues) to avoid duplicating work. If there isn't one already, please create one so that others know you're working on this +2. [Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the [phac-nml/mikrokondo repository](https://github.com/phac-nml/mikrokondo) to your GitHub account 3. Make the necessary changes / additions within your forked repository following [Pipeline conventions](#pipeline-contribution-conventions) 4. Use `nf-core schema build` and add any new parameters to the pipeline JSON schema (requires [nf-core tools](https://github.com/nf-core/tools) >= 1.10). 5. Submit a Pull Request against the `dev` branch and wait for the code to be reviewed and merged @@ -52,7 +52,7 @@ These tests are run both with the latest available version of `Nextflow` and als ## Pipeline contribution conventions -To make the mk-kondo/mikrokondo code and processing logic more understandable for new contributors and to ensure quality, we semi-standardise the way the code and other contributions are written. +To make the phac-nml/mikrokondo code and processing logic more understandable for new contributors and to ensure quality, we semi-standardise the way the code and other contributions are written. ### Adding a new step @@ -102,7 +102,7 @@ This repo includes a devcontainer configuration which will create a GitHub Codes To get started: -- Open the repo in [Codespaces](https://github.com/mk-kondo/mikrokondo/codespaces) +- Open the repo in [Codespaces](https://github.com/phac-nml/mikrokondo/codespaces) - Tools installed - nf-core - Nextflow diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 8d0eea5..47ee745 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,7 +15,7 @@ Learn more about contributing: [CONTRIBUTING.md](https://github.com/mk-kondo/mik - [ ] This comment contains a description of changes (with reason). - [ ] If you've fixed a bug or added code that should be tested, add tests! -- [ ] If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](https://github.com/mk-kondo/mikrokondo/tree/master/.github/CONTRIBUTING.md) +- [ ] If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](https://github.com/phac-nml/mikrokondo/tree/master/.github/CONTRIBUTING.md) - [ ] Make sure your code lints (`nf-core lint`). - [ ] Ensure the test suite passes (`nextflow run . -profile test,docker --outdir `). - [ ] Usage Documentation in `docs/usage.md` is updated.