[New Best Practice Guide]: Getting Started Guide for a Project
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 36
- Forks
- 14
- PR merge metrics
- No merged PRs in 30d
Description
Checked for duplicates
Yes - I've already checked
Describe the needs
It was discussed with @anilnatha that a getting started guide for new projects would be useful, covering:
- Setting up a repository with essential files
- Setting up branching structures
- Setting up settings if using GitHub
Effectively - a "getting started" guide that brings together existing SLIM deliverables relevant to new repositories / projects and creates a checklist.
Some automation solutions were discussed in: https://github.com/NASA-AMMOS/slim/issues/114
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 issue #114 and the existing SLIM deliverables relevant to new repositories or projects. Create a getting-started guide and checklist covering essential repository files, branching structures, and GitHub settings; done means these setup steps are brought together in one usable guide.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100