Skip to content

Commit 2e29fc3

Browse files
authored
Merge pull request uken#618 from uken/add-contribution-guideline-document
Add contribution guideline document
2 parents a4c7db0 + 5067851 commit 2e29fc3

File tree

3 files changed

+29
-0
lines changed

3 files changed

+29
-0
lines changed

CONTRIBUTING.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Contributing to fluent-plugin-elasticsearch
2+
===
3+
4+
We'd love your contribution. Here are the guidelines!
5+
6+
## Got a question or problem?
7+
8+
RESOURCES of [Official site's documentation](https://docs.fluentd.org/output/elasticsearch) and [ES plugin documentation](https://github.com/uken/fluent-plugin-elasticsearch/blob/master/README.md) may help you.
9+
10+
If you have further questions about ES plugin, feel free to [open an Issue](https://github.com/uken/fluent-plugin-elasticsearch/issues).
11+
12+
## Found a bug?
13+
14+
If you find a bug of ES plugin or a mistake in the documentation, you can help us by submitting an issue to ES plugin. Even better you can submit a pull request with a fix.
15+
16+
Note: Please follow the issue template/pull request template when sending your issue. Otherwise, your issue _might going to be closed with no response_.
17+
18+
## Patch Guidelines
19+
20+
Here are some things that would increase a chance that your patch is accepted:
21+
22+
* Write tests
23+
* Run tests before sending pull request with `bundle exec rake test`
24+
* Write [a good commit message](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)

ISSUE_TEMPLATE.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
(check apply)
2+
- [ ] read [the contribution guideline](CONTRIBUTING.md)
3+
14
#### Problem
25

36
...

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -1502,6 +1502,8 @@ There are usually a few feature requests, tagged [Easy](https://github.com/uken/
15021502

15031503
Pull Requests are welcomed.
15041504

1505+
Becore send a pull request or report an issue, please read [the contribution guideline](CONTRIBUTING.md).
1506+
15051507
[![Pull Request Graph](https://graphs.waffle.io/uken/fluent-plugin-elasticsearch/throughput.svg)](https://waffle.io/uken/fluent-plugin-elasticsearch/metrics)
15061508

15071509
## Running tests

0 commit comments

Comments
 (0)