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

Clean up some unnecessary folders and files #5

Merged
merged 5 commits into from
Jul 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 0 additions & 20 deletions .devcontainer/devcontainer.json

This file was deleted.

33 changes: 0 additions & 33 deletions .editorconfig

This file was deleted.

6 changes: 0 additions & 6 deletions .github/.dockstore.yml

This file was deleted.

28 changes: 8 additions & 20 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ 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!
Contributions to the code are even more welcome ;)

Since this repository is in construction, some of the points below might not apply yet (ex: tests, linter, naming conventions, versioning).
Make sure to do the maximum possible. If you are not sure about current standards or need support, you can ask help on the [#bioinfo](https://cr-ste-justine.slack.com/archives/C074VMACUD9slack) slack channel.

## Contribution workflow

If you'd like to write some code for ferlab/postprocessing, the standard workflow is as follows:
Expand All @@ -17,7 +20,7 @@ If you'd like to write some code for ferlab/postprocessing, the standard workflo
2. [Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the [ferlab/postprocessing repository](https://github.com/ferlab/postprocessing) 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
5. Submit a Pull Request against the main branch and wait for the code to be reviewed and merged

If you're not used to this workflow with git, you can start with some [docs from GitHub](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests) or even their [excellent `git` resources](https://try.github.io/).

Expand Down Expand Up @@ -48,13 +51,13 @@ Each `nf-core` pipeline should be set up with a minimal set of test-data.
If there are any failures then the automated tests fail.
These tests are run both with the latest available version of `Nextflow` and also the minimum required version that is stated in the pipeline code.

## Patch
## Hotfix

:warning: Only in the unlikely and regretful event of a release happening with a bug.

- On your own fork, make a new branch `patch` based on `upstream/master`.
- On your own fork, make a new branch `fix` based on `origin/main`.
- Fix the bug, and bump version (X.Y.Z+1).
- A PR should be made on `master` from patch to directly this particular bug.
- A PR should be made on `main` from fix to directly this particular bug.

## Pipeline contribution conventions

Expand All @@ -72,8 +75,7 @@ If you wish to contribute a new step, please use the following coding standards:
6. Add sanity checks and validation for all relevant parameters.
7. Perform local tests to validate that the new code works as expected.
8. If applicable, add a new test command in `.github/workflow/ci.yml`.
9. Update MultiQC config `assets/multiqc_config.yml` so relevant suffixes, file name clean up and module plots are in the appropriate order. If applicable, add a [MultiQC](https://https://multiqc.info/) module.
10. Add a description of the output files and if relevant any appropriate images from the MultiQC report to `docs/output.md`.
9. Add a description of the output files if relevant to `docs/output.md`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Merci pour le ménage! Je vois dans le fichier que peut-être ce serait bien de changer le nom de la branche sur le point numéro 5. On parle d'ouvrir un pull request sur la branche dev, on devrait plutot dire la branch principale dans notre cas (main je crois).

Copy link
Contributor

Choose a reason for hiding this comment

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

Ce serait bien aussi d'ajuster la section "Patch" et remplacer la branche "master" par main.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Merci pour le ménage! Je vois dans le fichier que peut-être ce serait bien de changer le nom de la branche sur le point numéro 5. On parle d'ouvrir un pull request sur la branche dev, on devrait plutot dire la branch principale dans notre cas (main je crois).

changé 'dev' pour 'main'

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ce serait bien aussi d'ajuster la section "Patch" et remplacer la branche "master" par main.

oui j'ai changé les 'patch' pour 'fix' ou 'hotfix' et remplacé master par main


### Default values

Expand Down Expand Up @@ -102,17 +104,3 @@ If you are using a new feature from core Nextflow, you may bump the minimum requ

For overview images and other documents we follow the nf-core [style guidelines and examples](https://nf-co.re/developers/design_guidelines).

## GitHub Codespaces

This repo includes a devcontainer configuration which will create a GitHub Codespaces for Nextflow development! This is an online developer environment that runs in your browser, complete with VSCode and a terminal.

To get started:

- Open the repo in [Codespaces](https://github.com/ferlab/postprocessing/codespaces)
- Tools installed
- nf-core
- Nextflow

Devcontainer specs:

- [DevContainer config](.devcontainer/devcontainer.json)
5 changes: 3 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@
Many thanks for contributing to ferlab/postprocessing!

Please fill in the appropriate checklist below (delete whatever is not relevant).
Since this repository is in construction, some of the points below regarding tests and linter might not apply yet. Make sure
to do the maximum possible. For now, the tests are performed manually. Add a description of your tests in your pull request.
You can ask help on the [#bioinfo](https://cr-ste-justine.slack.com/archives/C074VMACUD9slack) channel.
These are the most common things requested on pull requests (PRs).

Remember that PRs should be made against the dev branch, unless you're preparing a pipeline release.

Learn more about contributing: [CONTRIBUTING.md](https://github.com/ferlab/postprocessing/tree/master/.github/CONTRIBUTING.md)
-->

Expand Down
24 changes: 0 additions & 24 deletions .github/workflows/clean-up.yml

This file was deleted.

28 changes: 0 additions & 28 deletions .github/workflows/linting_comment.yml

This file was deleted.

75 changes: 0 additions & 75 deletions .github/workflows/release-announcements.yml

This file was deleted.

20 changes: 0 additions & 20 deletions .gitpod.yml

This file was deleted.

12 changes: 12 additions & 0 deletions .nf-core.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,24 @@ lint:
- .github/ISSUE_TEMPLATE/config.yml
- .github/workflows/awstest.yml
- .github/workflows/awsfulltest.yml
- .github/workflows/linting_comment.yml
- .github/.dockstore.yml
- .editorconfig
- .prettierignore
- .prettierrc.yml
- LICENSE
- assets/email_template.html
- assets/email_template.txt
- assets/sendmail_template.txt
files_unchanged:
- CODE_OF_CONDUCT.md
- assets/nf-core-postprocessing_logo_light.png
- docs/images/nf-core-postprocessing_logo_light.png
- docs/images/nf-core-postprocessing_logo_dark.png
- .github/ISSUE_TEMPLATE/bug_report.yml
- .github/CONTRIBUTING.md
- .github/PULL_REQUEST_TEMPLATE.md
- .github/workflows/linting_comment.yml
multiqc_config:
- report_comment
nextflow_config:
Expand Down
13 changes: 0 additions & 13 deletions .pre-commit-config.yaml

This file was deleted.

12 changes: 0 additions & 12 deletions .prettierignore

This file was deleted.

1 change: 0 additions & 1 deletion .prettierrc.yml

This file was deleted.

1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,5 @@ Initial release of ferlab/postprocessing, created with the [nf-core](https://nf-
### `Removed`
[#1](https://github.com/FelixAntoineLeSieur/Post-processing-Pipeline/pull/1) Removed input_schema
[#2](https://github.com/FelixAntoineLeSieur/Post-processing-Pipeline/pull/2) Removed V1 format input. V2 is the only accepted format.
[#5](https://github.com/Ferlab-Ste-Justine/Post-processing-Pipeline/pull/5) Removed many files related to workflows and email notifications

21 changes: 0 additions & 21 deletions LICENSE

This file was deleted.

Loading