In this repo you'll find the basic files all MeiliSearch repositories should contain at the root directory. Note that these templates are very generic, please modify them according to the particularities and requirements of your project.
- Open source license: the year should be changed
- README: changes required
- Contributing guidelines: changes required
- Pull request template: may require changes
- Issue templates: may require changes
- Code of conduct : no changes required
- Security policy: no changes required
| File | Changes required |
|---|---|
| Open source license | 📝 |
| README | 📝 |
| Contributing guidelines | 📝 |
| Pull request template | 📝 |
| Issue templates | 📝 |
| Code of conduct | 🚫 |
| Security policy | 🚫 |
In your README, try to answer the following questions:
- What does this project do?
- Why is this project useful?
- How do I get started?
- Where can I get more help, if I need it?
- Link to the contributing guidelines
- Link to the license
Consider adding the following elements to your contributing guidelines:
- Welcome and thank contributors
- Table of contents (if your file is long)
- Prerequisites (if any)
- Links to important ressources
- How to contribute (PR protocol...)
- Where to ask for help
Issue and PR templates are located in the .github/ directory.
Project contributors will automatically see the templates' contents in the issue or the PR body. You can learn more about issue and PR templates in the GitHub documentation.
There's always place for improvement! Please create an issue and / or submit a PR. Any suggestion or feedback is highly appreciated.
This template is inspired by the following resources: