llnl / llnl/open-source-guidelines

Consolidated documentation / best practices

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

Nobody has claimed this yet.

Dominant language
No language data
Stars
7
Forks
2
PR merge metrics
No merged PRs in 30d

Description

https://github.com/nationalparkservice/npmap-open-source-policy/blob/master/practice.md contains a lot of good information that we might be able to borrow / use to form our own 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 reading the linked practice.md document and then inspect the repository's existing guideline pages to identify overlapping or missing topics. Done means agreeing on the best practices to retain and consolidating them into this project's documentation, but the issue does not name target files or tests.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.