This is an automated email from the ASF dual-hosted git repository.
ulyssesyou pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-kyuubi-website.git
The following commit(s) were added to refs/heads/master by this push:
new 2546eca Improve Issue Tracker page (#41)
2546eca is described below
commit 2546eca86e85257d3f3d87b74e2df462d59a3cc7
Author: Kent Yao <[email protected]>
AuthorDate: Thu Mar 3 18:56:20 2022 +0800
Improve Issue Tracker page (#41)
---
src/issue_tracking.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++----
1 file changed, 46 insertions(+), 4 deletions(-)
diff --git a/src/issue_tracking.md b/src/issue_tracking.md
index 60a7ee3..62f6853 100644
--- a/src/issue_tracking.md
+++ b/src/issue_tracking.md
@@ -1,8 +1,8 @@
---
-title: Kyuubi Issue Tracking
+title: Issue Tracker
menu:
main:
- name: "Issue Tracking"
+ name: "Issue Tracker"
parent: "community"
---
<!---
@@ -19,6 +19,48 @@ menu:
limitations under the License. See accompanying LICENSE file.
-->
-The project tracks bugs and new features on [github
issues](https://github.com/apache/incubator-kyuubi/issues).
+The Kyuubi community uses [Github
Issues](https://github.com/apache/incubator-kyuubi/issues) to track various
ideas, work, bugs, etc.
+The Github issues tracker integrated with our development
[repository](https://github.com/apache/incubator-kyuubi) makes it easier to
organize work, focus on essential tasks, and keep plans up to date
simultaneously.
-If you'd like, you can also subscribe to [email protected] to get
emails about commits.
+Although everyone can create an issue that might include any content as long
as you have a Github account and we do not make any mandatory restrictions on
the functionality of this section, all communication is subject to the ASF
[Code of Conduct](https://www.apache.org/foundation/policies/conduct).
+If you observe behavior that violates those rules, please follow the [ASF
reporting
guidelines](https://www.apache.org/foundation/policies/conduct#reporting-guidelines).
+
+## How to Use Github Issues
+
+This section does not include any specific function of Github issues itself
which can be quickly learned from the docs of Github.
+
+### First Good Issue
+
+An issue with the label `good first issue` is an excellent way for first-time
contributors to start with Kyuubi.
+You can get a complete list
[here](https://github.com/apache/incubator-kyuubi/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
+
+### Report Bug
+
+It doesn't really matter whether what you are reporting is a bug or not. Just
feel free to share the problem you have encountered with the community.
+For best practices, if it is indeed a bug, please try to provide the
reproducible steps.
+It’s beneficial if the bug report has a description of how the bug was
introduced, by which commit or version, so that reviewers can easily understand
the bug.
+
+Try our [bug issue template
form](https://github.com/apache/incubator-kyuubi/issues/new?assignees=&labels=bug&template=bug-report.yml&title=%5BBug%5D+)
and fill as much information as you can provide.
+
+### Submit Ideas or Feature Requests
+
+As a volunteer-driven project, ideas are always welcome ;)
+
+Try our [feature template
form](https://github.com/apache/incubator-kyuubi/issues/new?assignees=&labels=feature&template=feature-request.yml&title=%5BFEATURE%5D+)
and make your proposal clear for others to understand.
+
+- Explain in detail how it would work.
+- Keep the scope as narrow as possible to make it easier to implement.
+
+For large features or major changes to the codebase, you may need to create a
[Kyuubi Project Improvement
Proposal](https://kyuubi.apache.org/improvement-proposals.html).
+
+### Fix Bugs
+
+Issues tagged with `bug` are open to whoever wants to fix them.
+
+### Implement Features
+
+Issues tagged with `feature` are open to whoever wants to implement them.
+
+### Ask Questions
+
+For general questions, please use [Mailing
Lists](https://kyuubi.apache.org/mailing_lists.html) first, from where you get
much more attention.
