Add `CONTRIBUTING.md` file
Open
Nobody has claimed this yet.
Prio: 3/Low
- Dominant language
- PHP
- Stars
- 22
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
With reference to the discussion had in https://github.com/Yoast/yoastcs/pull/96#discussion_r219403952, it may be a good idea to add a CONTRIBUTING.md file with some guidelines on:
- What belongs in this repo and what should be pulled upstream (WPCS/PHPCS)
- Basic guidelines for sniffs
- How to run the unit tests and such
Contributor guide
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
Read the discussion linked from pull request #96 for the context behind this request, then review the repository's existing sniff and unit-test setup. Add CONTRIBUTING.md with guidance on what belongs here versus WPCS/PHPCS, basic sniff guidelines, and how to run the unit tests; done when those contributor steps are documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100