|
| 1 | +## Contributing |
| 2 | + |
| 3 | +Hi there! We're thrilled that you'd like to contribute to this project. |
| 4 | +Your help is essential to keeping it great. |
| 5 | + |
| 6 | +### Opening an issue |
| 7 | + |
| 8 | +Each repository provides a template for issues. Please tell us the client and language version, and |
| 9 | +provide a clear description of the problem you're facing. Steps to reproduce, or example code |
| 10 | +(repository, jsfiddle, and such), are a big help. |
| 11 | + |
| 12 | +### Submitting a pull request |
| 13 | + |
| 14 | +Keep your changes as focused as possible. If there are multiple changes you'd like to make, |
| 15 | +please consider submitting them as separate pull requests unless they are related to each other. |
| 16 | + |
| 17 | +Here are a few tips to increase the likelihood of being merged: |
| 18 | + |
| 19 | +- [ ] Write tests. |
| 20 | +- [ ] Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). |
| 21 | +- [ ] Allow [edits from maintainers](https://blog.github.com/2016-09-07-improving-collaboration-with-forks/). |
| 22 | + |
| 23 | +### Security issues |
| 24 | +If you find any security risk in the project, please open an issue. |
| 25 | + |
| 26 | +### API Breaking changes |
| 27 | + |
| 28 | +We care deeply about backward compatibility for our API clients libraries. |
| 29 | +If it's necessary, we're ready to break backward compatibility, |
| 30 | +but this should be pretty rare. |
| 31 | + |
| 32 | +If you want to make a change that will break the backward compatibility of the API, |
| 33 | +open an issue first to discuss it with the maintainers. |
| 34 | + |
| 35 | +### Editing `README.md` and similar files |
| 36 | + |
| 37 | +Note that some files are managed outside this repository and are committed automatically. |
| 38 | + |
| 39 | +The `README.md` is generated automatically from our doc. If you'd like us to update this file, |
| 40 | +feel free to open an issue. |
| 41 | + |
| 42 | +`.github` directory is managed in [this repository](https://github.com/algolia/algoliasearch-client-common), |
| 43 | +any Pull Request there is welcome. |
| 44 | + |
| 45 | +## Label caption |
| 46 | + |
| 47 | +Labels across all Algolia API clients repositories are normalized. |
| 48 | + |
| 49 | +<!-- DO NOT EDIT THE TABLE NOR REMOVE HTML COMMENTS --> |
| 50 | +<!-- LABELTABLE --> |
| 51 | +| Label | Meaning | |
| 52 | +|---------------------------------------------------------------------------|----------------------------------------------------------------------------------------| |
| 53 | +|  Do not merge | PR should not be merged (decided by maintainers) | |
| 54 | +|  WIP | PR is not ready, no need to look at it (decided by contributors) | |
| 55 | +|  Ready | The PR is ready, reviewed, tests are green, if you're brave enough: click merge button | |
| 56 | +|  Waiting for API | The feature is implemented but the REST API is not live yet | |
| 57 | +|  Discussion | We need everyone's opinion on this, please join the conversation and share your ideas | |
| 58 | +|  Support | A user needs help but it's not really a bug | |
| 59 | +|  API feature | New API feature added to every client (like query rules) | |
| 60 | +|  Chore | CI, docs, and everything around the code | |
| 61 | +|  Bug | It's a bug, fix it! | |
| 62 | +|  Breaking change | RED ALERT! This means we need a new major version | |
| 63 | +|  Good First Issue | If you want to contribute, this one is _easy_ to tackle! | |
| 64 | + |
| 65 | +<!-- /LABELTABLE --> |
| 66 | +<!-- DO NOT REMOVE ANY HTML COMMENT --> |
| 67 | + |
| 68 | +## Resources |
| 69 | + |
| 70 | +- [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/) |
| 71 | +- [Using Pull Requests](https://help.github.com/articles/using-pull-requests/) |
| 72 | +- [GitHub Help](https://help.github.com) |
0 commit comments