oss developer experience: CONTRIBUTING.md is missing
Nobody has claimed this yet.
- Dominant language
- Haskell
- Stars
- 2.8k
- Forks
- 334
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 50
Description
Can the Wire team please put together something like https://github.com/reactiveui/ReactiveUI/blob/develop/CONTRIBUTING.md for folks like myself that documents the basics such as:
- git commit message conventions
- coding rules ("don't use OverloadedStrings, use ... instead")
- submission guidelines (what type of contributions you'll take)
- we require CLA to be signed (here is a copy of the document, if you need pre-approval from employer)
If you place these files in ~/ of the git repository then GitHub will display them when people send in pull-requests.
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 reviewing the linked ReactiveUI CONTRIBUTING.md example and the repository's existing contribution expectations. Add a root-level CONTRIBUTING.md covering commit message conventions, Haskell coding rules, accepted contribution types, and the CLA requirement. Done means GitHub can display the guide when contributors open pull requests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100