shift-org / shift-org/shift-docs
better document end-state of the art for new devs
Open
Nobody has claimed this yet.
high-priority
- Dominant language
- JavaScript
- Stars
- 30
- Forks
- 25
- Avg merge
- 9m
- Merged PRs (30d)
- 1
Description
Now that we're migrated, how do things work and how does a new dev get started? (see at least README and a look over what's in docs/*):
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 by reading the README and surveying docs/* to understand what is already documented after the migration. Map how the project currently works and how a new developer gets started, then update the documentation so both paths are clearly described and consistent.
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