-
Notifications
You must be signed in to change notification settings - Fork 223
Move CONTRIBUTING.md to docs/, review and update text, and add pipline-specific conventions section
#3903
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
base: dev
Are you sure you want to change the base?
Conversation
|
@christopher-hakkaart if you have an early version of a style guide, maybe we can use this page as a guinea pig (which doesn't fall in the website so it sort of falls out of our primary remit)? |
|
The text could be improved - mostly for consistency and removing unnecessary words to enhance clarity. The early style guide is linked below, but is subject to change. https://docs-v2--nf-core-docs.netlify.app/docs/contributors/documentation |
(self note) style guide: https://docs-v2--nf-core-docs.netlify.app/docs/developers/documentation/style_guide |
Argh - yeah that was my bad sorry, added the link and moved the page 20 min later 😅 |
… Claude Haiku 4.5, and ChatGPT-5)
| This page describes the recommended nf-core way for contributing to both {{ name }} and nf-core pipelines in general. | ||
| This page describes the recommended nf-core way to contribute to both {{ name }} and nf-core pipelines in general. | ||
|
|
||
| - [General contribution guidelines](#general-contribution-guidelines): for common procedures or guides across all nf-core pipelines. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
H2 headings
Co-authored-by: Chris Hakkaart <chris.hakkaart@seqera.io>
This PR partly addresses as first step nf-core/website#3653
CONTRIBUTING.mdtodocs/- to centralise all docs that should be displayed on the website for a pipelinePR checklist
CHANGELOG.mdis updateddocsis updated