Skip to content

Commit 666b2e9

Browse files
authored
Create CONTRIBUTING.md (#368)
* Create CONTRIBUTING.md * Create ISSUE_TEMPLATE * Create PULL_REQUEST_TEMPLATE
1 parent 873a8d8 commit 666b2e9

File tree

3 files changed

+84
-0
lines changed

3 files changed

+84
-0
lines changed

.github/ISSUE_TEMPLATE

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Please answer these questions before submitting your issue.
2+
3+
- Why do you submit this issue?
4+
- [ ] Question or discussion
5+
- [ ] Bug
6+
- [ ] Requirements
7+
- [ ] Feature or performance improvement
8+
- [ ] Other
9+
10+
___
11+
### Question
12+
- What do you want to know?
13+
14+
___
15+
### Bug
16+
- Which version of Apache APISIX Dashboard, OS and Broswer?
17+
18+
- What happened?
19+
If possible, provide a way to reproduce the error.
20+
21+
___
22+
### Requirement or improvement
23+
- Please describe your requirements or improvement suggestions.

.github/PULL_REQUEST_TEMPLATE

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Please answer these questions before submitting a pull request
2+
3+
- Why submit this pull request?
4+
- [ ] Bug fix
5+
- [ ] New feature provided
6+
- [ ] Improve performance
7+
8+
- Related issues
9+
10+
___
11+
### Bugfix
12+
- Description
13+
14+
- How to fix?
15+
16+
___
17+
### New feature or improvement
18+
- Describe the details and related test reports.

CONTRIBUTING.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Contributing to Apache APISIX Dashboard
2+
3+
Firstly, thanks for your interest in contributing! I hope that this will be a
4+
pleasant first experience for you, and that you will return to continue
5+
contributing.
6+
7+
## Code of Conduct
8+
9+
This project and everyone participating in it is governed by the Apache
10+
software Foundation's
11+
[Code of Conduct](http://www.apache.org/foundation/policies/conduct.html). By
12+
participating, you are expected to adhere to this code. If you are aware of
13+
unacceptable behavior, please visit the
14+
[Reporting Guidelines page](http://www.apache.org/foundation/policies/conduct.html#reporting-guidelines)
15+
and follow the instructions there.
16+
17+
## How to contribute?
18+
19+
Most of the contributions that we receive are code contributions, but you can
20+
also contribute to the documentation or simply report solid bugs
21+
for us to fix.
22+
23+
## How to report a bug?
24+
25+
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/apache/apisix-dashboard/issues).
26+
27+
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/apache/apisix-dashboard/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
28+
29+
30+
## How to add a new feature or change an existing one
31+
32+
_Before making any significant changes, please [open an issue](https://github.com/apache/apisix-dashboard/issues)._ Discussing your proposed changes ahead of time will make the contribution process smooth for everyone.
33+
34+
Once we've discussed your changes and you've got your code ready, make sure that tests are passing and open your pull request. Your PR is most likely to be accepted if it:
35+
36+
* Update the README.md with details of changes to the interface.
37+
* Includes tests for new functionality.
38+
* References the original issue in description, e.g. "resolve #123".
39+
* Has a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
40+
41+
## Do you have questions about the source code?
42+
43+
* Subscribe to our mail list and send the question mail to [[email protected]](mailto:[email protected])

0 commit comments

Comments
 (0)