nf-core / nf-core/website

Write guidelines for authorship

Open
#1,255 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement infrastructure
Dominant language
MDX
Stars
98
Forks
298
Avg merge
14h 38m
Merged PRs (30d)
38

Description

Write guidelines for authorship

Publications currently acknowledge only main authors of pipeline, but not nf-core community. What about adding “nf-core community” to the list of co-authors. Who should be listed there? Active contributors?:

Who should be in there:
Anyone who has made a commit in tools, website, respective pipeline, used modules, ?
Example: bioconda publication https://www.nature.com/articles/s41592-018-0046-7

  • Ask all papers to have ‘nf-core community’ consortium as co-author
  • Add acknowedlgments section to modules meta.yml (can add grant information statement)
  • Update template
  • Update website to render section
  • Write documentation

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the open questions, checklist, and linked Bioconda publication example to define who qualifies for authorship. Then locate the publication template, modules meta.yml, website rendering section, and documentation; the work is done when the authorship policy is agreed and all listed updates are implemented.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.