Skip to content

Commit 5438a51

Browse files
authored
templates: Added github templates for Issues and PRs as well as contributing guide. (thanos-io#368)
Signed-off-by: Bartek Plotka <bwplotka@gmail.com>
1 parent 761c177 commit 5438a51

File tree

4 files changed

+86
-1
lines changed

4 files changed

+86
-1
lines changed

.github/ISSUE_TEMPLATE.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
<!--
2+
Template relevant to bug reports only!
3+
4+
Keep issue title verbose enough and add prefix telling
5+
about what components it touches e.g "query:" or ".*:"
6+
-->
7+
8+
**Thanos, Prometheus and Golang version used**
9+
10+
<!--
11+
Output of "thanos --version" or docker image:tag used.
12+
(Double-check if all deployed components/services have expected versions)
13+
14+
If you are using custom build from master branch, have you checked out the tip of the master?
15+
-->
16+
17+
**What happened**
18+
19+
**What you expected to happen**
20+
21+
**How to reproduce it (as minimally and precisely as possible)**:
22+
23+
**Full logs to relevant components**
24+
25+
<!--
26+
Uncomment if you would like to post collapsible logs:
27+
28+
<details>Logs
29+
<p>
30+
31+
```
32+
```
33+
34+
</p>
35+
</details>
36+
-->
37+
38+
**Anything else we need to know**
39+
40+
<!--
41+
Uncomment and fill if you use not casual environment or if it might be relevant.
42+
43+
**Environment**:
44+
- OS (e.g. from /etc/os-release):
45+
- Kernel (e.g. `uname -a`):
46+
- Others:
47+
48+
-->

.github/PULL_REQUEST_TEMPLATE.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!--
2+
Keep PR title verbose enough and add prefix telling
3+
about what components it touches e.g "query:" or ".*:"
4+
-->
5+
6+
## Changes
7+
8+
<!-- Enumerate changes you made -->
9+
10+
## Verification
11+
12+
<!-- How you tested it? How do you know it works? -->

CONTRIBUTING.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Contributing
2+
3+
When contributing not obvious change to Thanos repository, please first
4+
discuss the change you wish to make via issue or slack, or any other
5+
method with the owners of this repository before making a change.
6+
7+
Please follow the [code of conduct](CODE_OF_CONDUCT.md) in all your interactions with the project.
8+
9+
## Pull Request Process
10+
11+
1. Read [getting started docs](docs/getting_started.md) and prepare Thanos.
12+
2. Familarize yourself with [Makefile](Makefile) commands like `format`, `build`, `proto` and `test`.
13+
3. Keep PRs as small as possible. Chain them if needed (base PR on other PRs).
14+
4. If you don't have a live object store ready add these envvars to skip tests for these:
15+
- THANOS_SKIP_GCS_TESTS to skip GCS tests.
16+
- THANOS_SKIP_S3_AWS_TESTS to skip AWS tests.
17+
18+
If you skip both of these, the store specific tests will be run against memory object storage only.
19+
CI runs GCS and inmem tests only for now. Not having these variables will produce auth errors against GCS or AWS tests.
20+
21+
5. If your change affects users (adds or removes feature) consider adding the item to [CHANGELOG](CHANGELOG.md)
22+
6. You may merge the Pull Request in once you have the sign-off of at least one developers with write access, or if you
23+
do not have permission to do that, you may request the second reviewer to merge it for you.
24+
7. If you feel like your PR waits too long for a review, feel free to ping [`#thanos-dev`](https://join.slack.com/t/improbable-eng/shared_invite/enQtMzQ1ODcyMzQ5MjM4LWY5ZWZmNGM2ODc5MmViNmQ3ZTA3ZTY3NzQwOTBlMTkzZmIxZTIxODk0OWU3YjZhNWVlNDU3MDlkZGViZjhkMjc) channel on our slack for review!

docs/getting_started.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ See [this](storage.md) for up-to-date list of available object stores for Thanos
88

99
## Requirements
1010

11-
* One or more [Prometheus](https://prometheus.io) v2.0.0 installations
11+
* One or more [Prometheus](https://prometheus.io) v2.2.1+ installations (v2.0.0 works too but is not recommended)
12+
* golang 1.10+
1213
* An object storage bucket (optional)
1314

1415
## Get Thanos!

0 commit comments

Comments
 (0)