Skip to content

Commit a5d4780

Browse files
julienbourdeaujulienbourdeau
authored
Merge pull request #340 from julienbourdeau/update/githubdir
Update common files
2 parents 5519774 + 8a8fffd commit a5d4780

File tree

5 files changed

+125
-7
lines changed

5 files changed

+125
-7
lines changed

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!--
2+
Please use this issue tracker only for reporting bugs or feature requests.
3+
4+
If you need support, please use:
5+
6+
- our community forum
7+
http://discourse.algolia.com
8+
9+
- StackOverflow with the `algolia` tag
10+
https://stackoverflow.com/questions/tagged/algolia
11+
12+
-->
13+
14+
- Algolia Client Version: #.#.#
15+
- Language Version:
16+
17+
### Description
18+
19+
20+
### Steps To Reproduce

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
| Q | A
2+
| ----------------- | ----------
3+
| Bug fix? | yes/no
4+
| New feature? | yes/no <!-- please update the /CHANGELOG.md file -->
5+
| BC breaks? | no
6+
| Related Issue | Fix #... <!-- will close issue automatically, if any -->
7+
| Need Doc update | yes/no
8+
9+
10+
## What was changed
11+
12+
<!--
13+
Please give the reviewers and contributors
14+
as many details as possible to understand your changes
15+
-->
16+
17+
## Why it was changed
18+
19+
<!--
20+
Please explain why this change is necessary or interesting
21+
-->

‎CONTRIBUTING.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
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+
| ![#050f2c](https://placehold.it/15/050f2c/000000?text=+) Do not merge | PR should not be merged (decided by maintainers) |
54+
| ![#ffc168](https://placehold.it/15/ffc168/000000?text=+) WIP | PR is not ready, no need to look at it (decided by contributors) |
55+
| ![#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 |
56+
| ![#ffc168](https://placehold.it/15/ffc168/000000?text=+) Waiting for API | The feature is implemented but the REST API is not live yet |
57+
| ![#3369e6](https://placehold.it/15/3369e6/000000?text=+) Discussion | We need everyone's opinion on this, please join the conversation and share your ideas |
58+
| ![#3369e6](https://placehold.it/15/3369e6/000000?text=+) Support | A user needs help but it's not really a bug |
59+
| ![#3369e6](https://placehold.it/15/3369e6/000000?text=+) API feature | New API feature added to every client (like query rules) |
60+
| ![#3369e6](https://placehold.it/15/3369e6/000000?text=+) Chore | CI, docs, and everything around the code |
61+
| ![#ff4f81](https://placehold.it/15/ff4f81/000000?text=+) Bug | It's a bug, fix it! |
62+
| ![#b60205](https://placehold.it/15/b60205/000000?text=+) Breaking change | RED ALERT! This means we need a new major version |
63+
| ![#ff6c5f](https://placehold.it/15/ff6c5f/000000?text=+) 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)

‎LICENSE‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
The MIT License (MIT)
1+
MIT License
22

3-
Copyright (c) 2013 Algolia
4-
http://www.algolia.com/
3+
Copyright (c) 2013-Present Algolia
54

65
Permission is hereby granted, free of charge, to any person obtaining a copy
76
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
109
copies of the Software, and to permit persons to whom the Software is
1110
furnished to do so, subject to the following conditions:
1211

13-
The above copyright notice and this permission notice shall be included in
14-
all copies or substantial portions of the Software.
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
1514

1615
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
1716
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
1817
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1918
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
2019
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22-
THE SOFTWARE.
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎MAINTAINERS.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
## `algolia/algoliasearch-client-python` maintainers
2+
3+
| Name | Email |
4+
|------------------|-----------------------------|
5+
| Léo Ercolanelli | [email protected] |
6+
| Julien Bourdeau | [email protected] |

0 commit comments

Comments
 (0)