meilisearch / meilisearch/scrapix
Create CONTRIBUTING.md
Open
Nobody has claimed this yet.
maintenance
- Dominant language
- TypeScript
- Stars
- 32
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
On order for contributors. but also for the team members to be quickly able to test the project after their changes, the contributing guide should definitely be added with the commands to run all tests.
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
Create CONTRIBUTING.md at the repository root. First inspect the project files to identify the existing test command, then document the command contributors and team members should run; done means the guide exists and includes how to run all tests.
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
- Mostly clear
- Newbie friendliness
- 55/100