Add support for displaying `CONTRIBUTING.md` on the nf-core website
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 98
- Forks
- 298
- Avg merge
- 14h 38m
- Merged PRs (30d)
- 38
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating how pipeline pages are rendered and where repository documentation is loaded. Use the existing CONTRIBUTING.md files and pipeline pages as examples, then verify that the contributing content is visible on the relevant website pages without hiding the existing documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation, web-dev
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100