nf-core / nf-core/website

Add documentation about using different devcontainers for codespaces

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

Nobody has claimed this yet.

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

Description

Following from the tools issue https://github.com/nf-core/tools/issues/2158 we will need to add documentation specifying that we have two devcontainer.json to use in GitHub codespaces. One for working on nf-core/tools and a different one for working in pipelines.

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 locating the website documentation and the two devcontainer.json configurations referenced in the issue. Document which configuration is for working on nf-core/tools and which is for working in pipelines, including how they are used in GitHub Codespaces; the related nf-core/tools issue provides context.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.