Skip to content

Add support for displaying CONTRIBUTING.md on the nf-core website #3653

@jfy133

Description

@jfy133

Is your feature request related to a problem? Please describe.

The CONTRIBUTING.md file is currently under utilised in nf-core pipelines.
It could be very useful for larger (VIP?) pipelines to document pipeline-specific development protcools and procedures, particularly if it includes interactive checklists etc. (e.g. https://nf-co.re/createtaxdb/dev/docs/usage/dev), however it's currently hidden away and not very visible

Describe the solution you'd like
The contributing.md page to be displayed on the website on pipeline pages, to ensure we retain a 'healthy' GitHub repository status, but can promote greater usage of the file.

Describe alternatives you've considered
Just assume developers will be aware of the file on the github repository.

Additional context
Add any other context or screenshots about the feature request here.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions