diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..1e7116b74 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,20 @@ + + +- Algolia Client Version: #.#.# +- Language Version: + +### Description + + +### Steps To Reproduce diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..2684d73c0 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,21 @@ +| Q | A +| ----------------- | ---------- +| Bug fix? | yes/no +| New feature? | yes/no +| BC breaks? | no +| Related Issue | Fix #... +| Need Doc update | yes/no + + +## What was changed + + + +## Why it was changed + + \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..30931c305 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,72 @@ +## Contributing + +Hi there! We're thrilled that you'd like to contribute to this project. +Your help is essential to keeping it great. + +### Opening an issue + +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. + +### Submitting a pull request + +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. +- [ ] Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). +- [ ] Allow [edits from maintainers](https://blog.github.com/2016-09-07-improving-collaboration-with-forks/). + +### Security issues +If you find any security risk in the project, please open an issue. + +### API Breaking changes + +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. + +### Editing `README.md` and similar files + +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](https://github.com/algolia/algoliasearch-client-common), +any Pull Request there is welcome. + +## Label caption + +Labels across all Algolia API clients repositories are normalized. + + + +| Label | Meaning | +|---------------------------------------------------------------------------|----------------------------------------------------------------------------------------| +| ![#050f2c](https://placehold.it/15/050f2c/000000?text=+) Do not merge | PR should not be merged (decided by maintainers) | +| ![#ffc168](https://placehold.it/15/ffc168/000000?text=+) WIP | PR is not ready, no need to look at it (decided by contributors) | +| ![#2ede98](https://placehold.it/15/2ede98/000000?text=+) Ready | The PR is ready, reviewed, tests are green, if you're brave enough: click merge button | +| ![#ffc168](https://placehold.it/15/ffc168/000000?text=+) Waiting for API | The feature is implemented but the REST API is not live yet | +| ![#3369e6](https://placehold.it/15/3369e6/000000?text=+) Discussion | We need everyone's opinion on this, please join the conversation and share your ideas | +| ![#3369e6](https://placehold.it/15/3369e6/000000?text=+) Support | A user needs help but it's not really a bug | +| ![#3369e6](https://placehold.it/15/3369e6/000000?text=+) API feature | New API feature added to every client (like query rules) | +| ![#3369e6](https://placehold.it/15/3369e6/000000?text=+) Chore | CI, docs, and everything around the code | +| ![#ff4f81](https://placehold.it/15/ff4f81/000000?text=+) Bug | It's a bug, fix it! | +| ![#b60205](https://placehold.it/15/b60205/000000?text=+) Breaking change | RED ALERT! This means we need a new major version | +| ![#ff6c5f](https://placehold.it/15/ff6c5f/000000?text=+) Good First Issue | If you want to contribute, this one is _easy_ to tackle! | + + + + +## Resources + +- [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/) +- [Using Pull Requests](https://help.github.com/articles/using-pull-requests/) +- [GitHub Help](https://help.github.com) diff --git a/LICENSE b/LICENSE index 8c315f450..fddf416f9 100644 --- a/LICENSE +++ b/LICENSE @@ -1,7 +1,6 @@ -The MIT License (MIT) +MIT License -Copyright (c) 2013 Algolia -http://www.algolia.com/ +Copyright (c) 2013-Present Algolia Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -10,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 000000000..fcde3d915 --- /dev/null +++ b/MAINTAINERS.md @@ -0,0 +1,6 @@ +## `algolia/algoliasearch-client-python` maintainers + +| Name | Email | +|------------------|-----------------------------| +| Léo Ercolanelli | leo.ercolanelli@algolia.com | +| Julien Bourdeau | julien.bourdeau@algolia.com |