kir-dev / kir-dev/parkett-klub-api
Readme update
- Dominant language
- Ruby
- Stars
- 2
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Jelenleg csak a default Readme van a projektben, az újonnan csatlakozóknak nagy segítség, ha le van írva, hogy történik a project setup. Ehhez lehet használni a PéK, illetve a Schörpong readme-jét is. Szintén hasznos blogposzt a témában: [How to write a kickass readme](https://dev.to/scottydocs/how-to-write-a-kickass-readme-5af9)
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the repository's default README and compare its setup coverage with the PéK and Schörpong READMEs. Document the project setup steps for newcomers, using the linked “How to write a kickass readme” post as guidance; done when a new contributor can follow the README to get started.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rails, ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 62/100