114fefefa6
<!-- Thanks for sending a pull request! Here are some tips for you: 1. If this is your first time, please read our contributor guidelines: https://kyuubi.readthedocs.io/en/latest/community/contributions.html 2. If the PR is related to an issue in https://github.com/apache/incubator-kyuubi/issues, add '[KYUUBI #XXXX]' in your PR title, e.g., '[KYUUBI #XXXX] Your PR title ...'. 3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][KYUUBI #XXXX] Your PR title ...'. --> ### _Why are the changes needed?_ <!-- Please clarify why the changes are needed. For instance, 1. If you add a feature, you can talk about the use case of it. 2. If you fix a bug, you can clarify why it is a bug. --> Add CONTRIBUTING.md to list COMMUNITY resources that I contributor can use delete contributions and improvement-proposal in main repo ### _How was this patch tested?_ - [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible - [ ] Add screenshots for manual tests if appropriate - [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request Closes #2004 from yaooqinn/CONTRIBUTING. Closes #2004 ddbcd521 [Kent Yao] CONTRIBUTING f81c14b3 [Kent Yao] Merge branch 'master' of github.com:apache/incubator-kyuubi into CONTRIBUTING 3bdbdc9b [Kent Yao] CONTRIBUTING 574ceff2 [Kent Yao] CONTRIBUTING f0a6b4c4 [Kent Yao] CONTRIBUTING c55c6a02 [Kent Yao] CONTRIBUTING Authored-by: Kent Yao <yao@apache.org> Signed-off-by: ulysses-you <ulyssesyou@apache.org>
63 lines
3.3 KiB
Markdown
63 lines
3.3 KiB
Markdown
<!--
|
||
- Licensed to the Apache Software Foundation (ASF) under one or more
|
||
- contributor license agreements. See the NOTICE file distributed with
|
||
- this work for additional information regarding copyright ownership.
|
||
- The ASF licenses this file to You under the Apache License, Version 2.0
|
||
- (the "License"); you may not use this file except in compliance with
|
||
- the License. You may obtain a copy of the License at
|
||
-
|
||
- http://www.apache.org/licenses/LICENSE-2.0
|
||
-
|
||
- Unless required by applicable law or agreed to in writing, software
|
||
- distributed under the License is distributed on an "AS IS" BASIS,
|
||
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
- See the License for the specific language governing permissions and
|
||
- limitations under the License.
|
||
-->
|
||
|
||
# Contributing to Apache Kyuubi
|
||
|
||
<img src="https://svn.apache.org/repos/asf/comdev/project-logos/originals/kyuubi-1.svg" alt="Kyuubi logo" width="50%" align="right" />
|
||
|
||
Thanks for your interest in the Apache Kyuubi project.
|
||
Contributions are welcome and are greatly appreciated!
|
||
Every little bit helps, and a credit will always be given.
|
||
|
||
This page provides some orientation and resources we have for you to get involved.
|
||
It also offers recommendations on getting the best results when engaging with the community.
|
||
We hope that this will be a pleasant first experience for you to return to continue contributing.
|
||
|
||
## Get Involved
|
||
|
||
In the process of using Apache Kyuubi, if you have any questions, suggestions, or improvement ideas, you can participate in the Kyuubi community building through the following suggested channels.
|
||
|
||
- Join the [Mailing Lists](https://kyuubi.apache.org/mailing_lists.html) - the best way to keep up-to-date with the community.
|
||
- [Issue Tracker](https://kyuubi.apache.org/issue_tracking.html) - tracking bugs, ideas, plans, etc.
|
||
- [Github Discussions](https://github.com/apache/incubator-kyuubi/discussions) - second to mailing list for anything else you want to share or ask
|
||
|
||
## Contributing Guide
|
||
|
||
As a community-driven project. All bits of help are welcome.
|
||
|
||
Contributing code is excellent, but that’s probably not the first place to start.
|
||
There are many ways to make valuable contributions to the project and community.
|
||
|
||
You can make various types of contributions to Kyuubi, including the following but not limited to,
|
||
|
||
- Answer questions in the [Mailing Lists](https://kyuubi.apache.org/mailing_lists.html)
|
||
- [Share your success stories with us](https://github.com/apache/incubator-kyuubi/discussions/925)
|
||
- Improve Documentation - [](https://kyuubi.apache.org/docs/latest/)
|
||
- Test latest releases - [](https://github.com/apache/incubator-kyuubi/tags)
|
||
- Improve test coverage - [](https://codecov.io/gh/apache/incubator-kyuubi)
|
||
- Report bugs and better help developers to reproduce
|
||
- Review changes
|
||
- Make a pull request
|
||
- Promote to others
|
||
- Click the star button if you like this project
|
||
|
||
Before you start, we recommend that you check the [Contribution Guidelines](https://kyuubi.apache.org/contributing.html) first.
|
||
|
||
## Easter Eggs for Contributors
|
||
|
||
TBD, please be patient for the surprise.
|