leancodepl / leancodepl/contractsgenerator
Provide `DO's` and `DON'Ts` in guidelines
Open
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 9
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
This may sound redundant but I always like when docs, aside from textual explanation, provide some code samples with DOs and DON'Ts
Originally posted by @bartekpacia in https://github.com/leancodepl/contractsgenerator/pull/90#discussion_r965740941
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 locating the guidelines documentation referenced by the issue. Add clear code samples showing recommended DOs and DON'Ts alongside the existing textual explanations, then confirm the guidelines contain both types of examples.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100