Skip to content

Commit 6a12bf5

Browse files
author
Amanda Sullivan
committed
Updating contribution docs
1 parent 7da0ba7 commit 6a12bf5

File tree

6 files changed

+18
-18
lines changed

6 files changed

+18
-18
lines changed

.github/CONTRIBUTING.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
# mira/cli: Contributing Guidelines
1+
# mira-nf/mira: Contributing Guidelines
22

33
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.
55

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.
77
Please use the pre-filled template to save time.
88

99
However, don't be put off by this template - other more general issues and suggestions are welcome!
1010
Contributions to the code are even more welcome ;)
1111

1212
## Contribution workflow
1313

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:
1515

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
1818
3. Make the necessary changes / additions within your forked repository following [Pipeline conventions](#pipeline-contribution-conventions)
1919
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).
2020
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
5858

5959
## Pipeline contribution conventions
6060

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.
6262

6363
### Adding a new step
6464

@@ -108,7 +108,7 @@ This repo includes a devcontainer configuration which will create a GitHub Codes
108108

109109
To get started:
110110

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)
112112
- Tools installed
113113
- nf-core
114114
- Nextflow

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
<!--
2-
# mira/cli pull request
2+
# mira-nf/mira pull request
33
4-
Many thanks for contributing to mira/cli!
4+
Many thanks for contributing to mira-nf/mira!
55
66
Please fill in the appropriate checklist below (delete whatever is not relevant).
77
These are the most common things requested on pull requests (PRs).
88
99
Remember that PRs should be made against the dev branch, unless you're preparing a pipeline release.
1010
11-
Learn more about contributing: [CONTRIBUTING.md](https://github.com/mira/cli/tree/master/.github/CONTRIBUTING.md)
11+
Learn more about contributing: [CONTRIBUTING.md](https://github.com/mira-nf/mira/tree/master/.github/CONTRIBUTING.md)
1212
-->
1313

1414
## PR checklist
1515

1616
- [ ] This comment contains a description of changes (with reason).
1717
- [ ] If you've fixed a bug or added code that should be tested, add tests!
18-
- [ ] If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](https://github.com/mira/cli/tree/master/.github/CONTRIBUTING.md)
18+
- [ ] If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](https://github.com/CDCgov/MIRA-NF/tree/master/.github/CONTRIBUTING.md)
1919
- [ ] Make sure your code lints (`nf-core lint`).
2020
- [ ] Ensure the test suite passes (`nextflow run . -profile test,docker --outdir <OUTDIR>`).
2121
- [ ] Check for unexpected warnings in debug mode (`nextflow run . -profile debug,test,docker --outdir <OUTDIR>`).

.github/workflows/branch.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ jobs:
1111
steps:
1212
# PRs to the nf-core repo master branch are only ok if coming from the nf-core repo `dev` or any `patch` branches
1313
- name: Check PRs
14-
if: github.repository == 'mira/cli'
14+
if: github.repository == 'mira-nf/mira'
1515
run: |
16-
{ [[ ${{github.event.pull_request.head.repo.full_name }} == mira/cli ]] && [[ $GITHUB_HEAD_REF == "dev" ]]; } || [[ $GITHUB_HEAD_REF == "patch" ]]
16+
{ [[ ${{github.event.pull_request.head.repo.full_name }} == mira-nf/mira ]] && [[ $GITHUB_HEAD_REF == "dev" ]]; } || [[ $GITHUB_HEAD_REF == "patch" ]]
1717
1818
# If the above check failed, post a comment on the PR explaining the failure
1919
# NOTE - this doesn't currently work if the PR is coming from a fork, due to limitations in GitHub actions secrets

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jobs:
1919
test:
2020
name: Run pipeline with test data
2121
# Only run on push if this is the nf-core dev branch (merged PRs)
22-
if: "${{ github.event_name != 'push' || (github.event_name == 'push' && github.repository == 'mira/cli') }}"
22+
if: "${{ github.event_name != 'push' || (github.event_name == 'push' && github.repository == 'mira-nf/mira') }}"
2323
runs-on: ubuntu-latest
2424
strategy:
2525
matrix:

.github/workflows/fix-linting.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ jobs:
99
if: >
1010
contains(github.event.comment.html_url, '/pull/') &&
1111
contains(github.event.comment.body, '@nf-core-bot fix linting') &&
12-
github.repository == 'mira/cli'
12+
github.repository == 'mira-nf/mira'
1313
runs-on: ubuntu-latest
1414
steps:
1515
# Use the @nf-core-bot token to check out so we can push later
@@ -86,4 +86,4 @@ jobs:
8686
issue-number: ${{ github.event.issue.number }}
8787
body: |
8888
@${{ github.actor }} I tried to fix the linting errors, but it didn't work. Please fix them manually.
89-
See [CI log](https://github.com/mira/cli/actions/runs/${{ github.run_id }}) for more details.
89+
See [CI log](https://github.com/mira-nf/mira/actions/runs/${{ github.run_id }}) for more details.

CITATIONS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# mira/cli: Citations
1+
# mira-nf/mira: Citations
22

33
## [nf-core](https://pubmed.ncbi.nlm.nih.gov/32055031/)
44

0 commit comments

Comments
 (0)