-
Notifications
You must be signed in to change notification settings - Fork 253
Add guidance on what different pipeline contributions they are #3542
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
Open
jfy133
wants to merge
7
commits into
main
Choose a base branch
from
add-guidances-of-peiplein-contributions
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
e36beab
Add first draft of contribution types to pipelines. Probably needs bu…
jfy133 543bcb8
move image to correct position
mashehu 981f229
allow images from sub-sites
mashehu 2bd3431
Revert "allow images from sub-sites"
mashehu 86755d2
add correct domain
mashehu 7059ee1
Apply suggestions from code review
jfy133 7bba9a6
[automated] Fix code linting
nf-core-bot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| # Local Netlify folder | ||
| .netlify |
This file contains hidden or 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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
83 changes: 83 additions & 0 deletions
83
sites/docs/src/content/docs/contributing/pipelines/contribution_types.md
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| --- | ||
| title: Contribution types | ||
| subtitle: Guidance for distinguishing between different types of contributors to nf-core pipelines | ||
| parentWeight: 10 | ||
| --- | ||
|
|
||
| All nf-core pipelines have a `nextflow.config` file, that within which has a 'manifest' listing all contributors to a pipeline. | ||
|
|
||
| This section of the manifest have a specific attribute called 'contributions' that is designed to describe what each person has done for the pipeline. | ||
|
|
||
| In this page we will describe the nf-core community's guidance on how to use the contribution attribution, to maximise community recognition to all of out pipelines. | ||
|
|
||
| ## Contribution types | ||
|
|
||
| The [manifest](<(https://nextflow.io/docs/latest/reference/config.html#manifest)>) supports three contribution types: | ||
|
|
||
| - `author` | ||
| - `maintainer` | ||
| - `contributor` | ||
|
|
||
| The following sections describe how nf-core attributes contributions using these types. | ||
|
|
||
| ### Author | ||
|
|
||
| An `author` is someone who designed and wrote the original pipeline (prior to and including version 1.0) and served as the primary maintainer at that time. | ||
|
|
||
| Someone may also be an `author` if they previously served as a lead `maintainer` of the pipeline. As a lead `maintainer`, they: | ||
|
|
||
| - Kept the pipeline up to date | ||
| - Reviewed pull requests | ||
| - Developed the long-term roadmap | ||
| - Added new features | ||
| - Coordinated development with other developers and users | ||
|
|
||
| A pipeline can have multiple authors. | ||
|
|
||
| ### Maintainer | ||
|
|
||
| A `maintainer` is currently active as a lead developer of the pipeline and regularly contributes code and manages the project. Maintainers: | ||
|
|
||
| - Keep the pipeline up to date | ||
| - Review pull requests | ||
| - Execute the long-term roadmap | ||
| - Add new features | ||
| - Coordinate with other developers and users | ||
|
|
||
| A `maintainer` typically has the best current understanding of the pipeline. | ||
| A pipeline can have multiple maintainers. | ||
|
|
||
| A `maintainer` doesn't need to be an original author of the pipeline, but can be. | ||
|
|
||
| When a `maintainer` steps down and no longer actively contributes to or manages the pipeline, they become an `author`. | ||
| You can optionally also add the `contributor` designation (see [Contributor](#contributor)). | ||
|
|
||
| ### Contributor | ||
|
|
||
| A `contributor` occasionally contributes to the pipeline (code, documentation, or other) but doesn't have a management role. Contributors typically do not triage or resolve GitHub issues, but may occasionally contribute features or resolve bugs. | ||
|
|
||
| Contributors can be both current and past. | ||
|
|
||
| ## Case study | ||
|
|
||
| The nf-core/mag pipeline demonstrates how to distinguish between the different contribution types. | ||
|
|
||
|  | ||
|
|
||
| - Hadrien was the original architect and wrote the majority of v1 of the pipeline from 2018, and finished developing v1 in 2020. He is therefore an author. | ||
| - Daniel and Sabrina started assisting Hadrien in 2019, and took over as the lead maintainers between 2019-2022 keeping the pipeline up to date and adding new features. During this period they were maintainers. | ||
| - Maxime and James started in occasioanlly contributing feautures and bug fixes between 2020-2021, but were not handling the project management. During this period they were just contributors. | ||
| - In 2023, Sabrina moved on and stepped down as a project lead. She then moved to an 'author' designation. | ||
| - When Sabrina stepped down, James took over with managing the roadmap and triaging bug fixes, he thus changed from 'contributor' to 'maintainer' status. | ||
|
|
||
| ## Final notes | ||
|
|
||
| A person can have one or more contribution designations. | ||
| Evaluate each contributor's role and apply the appropriate types. | ||
|
|
||
| :::note{title="Important"} | ||
| Never _remove_ anyone from the contributor list. Acknowledge everyone who has contributed to the pipeline at any point in its history, whether in version 1 or version 10. | ||
| ::: | ||
|
|
||
| Community and collaboration are core to nf-core. | ||
| Using these contribution types helps strengthen community ownership of pipelines and supports their long-term maintenance! | ||
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.
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.