[apisix-dashboard] branch master updated: Create CONTRIBUTING.md (#368)

[ju...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

juzhiyuan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-dashboard.git


The following commit(s) were added to refs/heads/master by this push:
     new 666b2e9  Create CONTRIBUTING.md (#368)
666b2e9 is described below

commit 666b2e9e7220d50150a28009343f619f1d886093
Author: 琚致远 <ju...@apache.org>
AuthorDate: Fri Aug 7 07:46:54 2020 +0800

    Create CONTRIBUTING.md (#368)
    
    * Create CONTRIBUTING.md
    
    * Create ISSUE_TEMPLATE
    
    * Create PULL_REQUEST_TEMPLATE
---
 .github/ISSUE_TEMPLATE        | 23 +++++++++++++++++++++++
 .github/PULL_REQUEST_TEMPLATE | 18 ++++++++++++++++++
 CONTRIBUTING.md               | 43 +++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 84 insertions(+)

diff --git a/.github/ISSUE_TEMPLATE b/.github/ISSUE_TEMPLATE
new file mode 100644
index 0000000..be81252
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE
@@ -0,0 +1,23 @@
+Please answer these questions before submitting your issue.
+
+- Why do you submit this issue?
+- [ ] Question or discussion
+- [ ] Bug
+- [ ] Requirements
+- [ ] Feature or performance improvement
+- [ ] Other
+
+___
+### Question
+- What do you want to know?
+
+___
+### Bug
+- Which version of Apache APISIX Dashboard, OS and Broswer?
+
+- What happened?
+If possible, provide a way to reproduce the error.
+
+___
+### Requirement or improvement
+- Please describe your requirements or improvement suggestions.
diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE
new file mode 100644
index 0000000..d4051d9
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE
@@ -0,0 +1,18 @@
+Please answer these questions before submitting a pull request
+
+- Why submit this pull request?
+- [ ] Bug fix
+- [ ] New feature provided
+- [ ] Improve performance
+
+- Related issues
+
+___
+### Bugfix
+- Description
+
+- How to fix?
+
+___
+### New feature or improvement
+- Describe the details and related test reports.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..b84ca15
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,43 @@
+# Contributing to Apache APISIX Dashboard
+
+Firstly, thanks for your interest in contributing! I hope that this will be a
+pleasant first experience for you, and that you will return to continue
+contributing.
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the Apache
+software Foundation's
+[Code of Conduct](http://www.apache.org/foundation/policies/conduct.html). By
+participating, you are expected to adhere to this code. If you are aware of
+unacceptable behavior, please visit the
+[Reporting Guidelines page](http://www.apache.org/foundation/policies/conduct.html#reporting-guidelines)
+and follow the instructions there.
+
+## How to contribute?
+
+Most of the contributions that we receive are code contributions, but you can
+also contribute to the documentation or simply report solid bugs
+for us to fix.
+
+## How to report a bug?
+
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/apache/apisix-dashboard/issues).
+
+* 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.
+
+
+## How to add a new feature or change an existing one
+
+_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.
+
+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:
+
+* Update the README.md with details of changes to the interface.
+* Includes tests for new functionality.
+* References the original issue in description, e.g. "resolve #123".
+* Has a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+
+## Do you have questions about the source code?
+
+* Subscribe to our mail list and send the question mail to [dev@apisix.apache.org](mailto:dev@apisix.apache.org)