|
1 |
| -# mira/cli: Contributing Guidelines |
| 1 | +# mira-nf/mira: Contributing Guidelines |
2 | 2 |
|
3 | 3 | Hi there!
|
4 |
| -Many thanks for taking an interest in improving mira/cli. |
| 4 | +Many thanks for taking an interest in improving mira-nf/mira. |
5 | 5 |
|
6 |
| -We try to manage the required tasks for mira/cli using GitHub issues, you probably came to this page when creating one. |
| 6 | +We try to manage the required tasks for mira-nf/mira using GitHub issues, you probably came to this page when creating one. |
7 | 7 | Please use the pre-filled template to save time.
|
8 | 8 |
|
9 | 9 | However, don't be put off by this template - other more general issues and suggestions are welcome!
|
10 | 10 | Contributions to the code are even more welcome ;)
|
11 | 11 |
|
12 | 12 | ## Contribution workflow
|
13 | 13 |
|
14 |
| -If you'd like to write some code for mira/cli, the standard workflow is as follows: |
| 14 | +If you'd like to write some code for mira-nf/mira, the standard workflow is as follows: |
15 | 15 |
|
16 |
| -1. Check that there isn't already an issue about your idea in the [mira/cli issues](https://github.com/mira/cli/issues) to avoid duplicating work. If there isn't one already, please create one so that others know you're working on this |
17 |
| -2. [Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the [mira/cli repository](https://github.com/mira/cli) to your GitHub account |
| 16 | +1. Check that there isn't already an issue about your idea in the [mira-nf/mira issues](https://github.com/CDCgov/MIRA-NF/issues) to avoid duplicating work. If there isn't one already, please create one so that others know you're working on this |
| 17 | +2. [Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the [mira-nf/mira repository](https://github.com/CDCgov/MIRA-NF) to your GitHub account |
18 | 18 | 3. Make the necessary changes / additions within your forked repository following [Pipeline conventions](#pipeline-contribution-conventions)
|
19 | 19 | 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).
|
20 | 20 | 5. Submit a Pull Request against the `dev` branch and wait for the code to be reviewed and merged
|
@@ -58,7 +58,7 @@ These tests are run both with the latest available version of `Nextflow` and als
|
58 | 58 |
|
59 | 59 | ## Pipeline contribution conventions
|
60 | 60 |
|
61 |
| -To make the mira/cli 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. |
| 61 | +To make the mira-nf/mira 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. |
62 | 62 |
|
63 | 63 | ### Adding a new step
|
64 | 64 |
|
@@ -108,7 +108,7 @@ This repo includes a devcontainer configuration which will create a GitHub Codes
|
108 | 108 |
|
109 | 109 | To get started:
|
110 | 110 |
|
111 |
| -- Open the repo in [Codespaces](https://github.com/mira/cli/codespaces) |
| 111 | +- Open the repo in [Codespaces](https://github.com/mira-nf/mira/codespaces) |
112 | 112 | - Tools installed
|
113 | 113 | - nf-core
|
114 | 114 | - Nextflow
|
|
0 commit comments