llnl / llnl/open-source-guidelines
Open Source Checklist
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 7
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
We should see about adding something like https://github.com/cfpb/open-source-checklist into our best practices so that we can make sure whatever is released and pushed out is, and stays, "clean" for however we end up defining that.
Some things to watch out for include:
- checked in passwords (see also: https://github.com/18F/seekret)
- internal bitbucket URLs
- others?
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 reviewing the repository's existing best practices and the linked CFPB open-source-checklist and 18F seekret references. Define what “clean” means for released projects, then document checks covering committed passwords, internal Bitbucket URLs, and any other agreed risks.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, security
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100