shift-org / shift-org/shift-docs
updating local dev docs
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 30
- Forks
- 25
- Avg merge
- 9m
- Merged PRs (30d)
- 1
Description
Let's put a bit of effort into getting the README.md for local dev updated, esp now that we are past the docker-compose vs docker compose BS. Maybe @aaronminnick could help us validate/improve the windows docs too? This would leave us in a good place to do another recruitment ride during PP :D
Contributor guide
No contributing guide indexed for this repository
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 with README.md and review the local development instructions, especially the docker-compose versus docker compose guidance and the Windows documentation. Update the README so the current commands and Windows setup are accurate and useful for recruiting contributors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker-compose
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100