NWChemEx / NWChemEx/.github

Factor out `docs/README.md`

Open
#86 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation good first issue
Dominant language
Dockerfile
Stars
1
Forks
2
Avg merge
22m
Merged PRs (30d)
4

Description

The build instructions for each repo are identical (aside from the name of the repo). We should factor them out into the .github repo and have the README.md files point to the .github version.

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 with docs/README.md and compare the identical build instructions in the organization repositories. Move the shared instructions into the .github version and update each repository's README.md to point there; done when the duplicated instructions are removed and the links preserve repo-specific names.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.