Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential to keeping it great.
Each repository provides a template for issues. Please tell us the client and language version, and provide a clear description of the problem you're facing. Steps to reproduce, or example code (repository, jsfiddle, and such), are a big help.
Keep your changes as focused as possible. If there are multiple changes you'd like to make, please consider submitting them as separate pull requests unless they are related to each other.
Here are a few tips to increase the likelihood of being merged:
- Write tests & run them
$ python3 -m venv venv $ source venv/bin/activate $ pip install -r requirements.txt $ ALGOLIA_APPLICATION_ID=*** ALGOLIA_API_KEY=*** tox
- Write a good commit message.
- Allow edits from maintainers.
If you find any security risk in the project, please open an issue.
We care deeply about backward compatibility for our API clients libraries. If it's necessary, we're ready to break backward compatibility, but this should be pretty rare.
If you want to make a change that will break the backward compatibility of the API, open an issue first to discuss it with the maintainers.
Note that some files are managed outside this repository and are committed automatically.
The README.md is generated automatically from our doc. If you'd like us to update this file,
feel free to open an issue.
.github directory is managed in this repository,
any Pull Request there is welcome.
Labels across all Algolia API clients repositories are normalized.
| Label | Meaning |
|---|---|
| PR should not be merged (decided by maintainers) | |
| PR is not ready, no need to look at it (decided by contributors) | |
| The PR is ready, reviewed, tests are green, if you're brave enough: click merge button | |
| The feature is implemented but the REST API is not live yet | |
| We need everyone's opinion on this, please join the conversation and share your ideas | |
| A user needs help but it's not really a bug | |
| New API feature added to every client (like query rules) | |
| CI, docs, and everything around the code | |
| It's a bug, fix it! | |
| RED ALERT! This means we need a new major version | |
| If you want to contribute, this one is easy to tackle! |