Add CI to contributing #703
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jashapiro
approved these changes
Feb 21, 2024
| - [Check Nextflow config](.github/workflows/nextflow-config-check.yaml): This workflow ensures that there are no syntax errors in the Nextflow configuration files | ||
|
|
||
| There is also one additional `pre-commit ci` workflow which runs all [pre-commit hooks as described in this section](#pre-commit-hooks), except for the spell check pre-commit hook. | ||
| Although highly recommended, it is not required that this workflow passes before pull requests can be merged. |
There was a problem hiding this comment.
Spell check is not required to pass either, the way this repo is currently set up.
There was a problem hiding this comment.
Ah, didn't know that! Also looks like the precommit ci only runs on development (if i'm reading the yaml syntax correctly), so will change that too.
There was a problem hiding this comment.
No, it runs everywhere. That is where it files its PRs to (when updating hook versions)
Co-authored-by: Joshua Shapiro <josh.shapiro@ccdatalab.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #695
Here I've added a small section about CI into contributing. I nested this inside the PRs header and mentioned both required workflows and the pre-commit ci workflow (do I still have it correct that passing is not mandatory? I don't have access to Settings here so couldn't tell for sure).
Let me know if this is the right place in
CONTRIBUTING.mdto have added this, as well as any details to be expanded upon or reduced.