5032901dfc
### _Why are the changes needed?_ Guidelines for Document and Code Contributions. - code style - documentation style - quick starts - sphinx-copybutton for copy button in code blocks - add kind:minor,help wanted,good first issue to doc issue template ### _How was this patch tested?_ - [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible - [x] Add screenshots for manual tests if appropriate <img width="1325" alt="image" src="https://user-images.githubusercontent.com/8326978/234193368-473e2a1d-2deb-4d91-901a-19cea58a489b.png"> - [x] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request Closes #4768 from yaooqinn/guide. Closes #4768 3a0bd395b [Kent Yao] Update docs/contributing/doc/build.rst 8fe4f6d14 [Kent Yao] Update docs/contributing/doc/build.rst a753bdde5 [Kent Yao] Guidelines for Document and Code contributions f8393fe8d [Kent Yao] Guidelines for Document and Code contributions 8f2d3ce82 [Kent Yao] Guidelines for Document and Code contributions 4f3a2128b [Kent Yao] Guidelines for Document and Code contributions Authored-by: Kent Yao <yao@apache.org> Signed-off-by: Cheng Pan <chengpan@apache.org>
71 lines
2.9 KiB
ReStructuredText
71 lines
2.9 KiB
ReStructuredText
.. 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.
|
|
|
|
Get Started
|
|
===========
|
|
|
|
Good First Issues
|
|
-----------------
|
|
|
|
.. image:: https://img.shields.io/github/issues/apache/kyuubi/good%20first%20issue?color=green&label=Good%20first%20issue&logo=gfi&logoColor=red&style=for-the-badge
|
|
:alt: GitHub issues by-label
|
|
:target: `Good First Issues`_
|
|
|
|
**Good First Issue** is initiative to curate easy pickings for first-time
|
|
contributors. It helps you locate suitable development tasks with beginner's
|
|
skills required, and finally make your first contribution to Kyuubi.
|
|
|
|
After solving one or more good first issues, you should be able to
|
|
|
|
- Find efficient ways to communicate with the community and get help
|
|
- Setup `develop environment`_ on your machine
|
|
- `Build`_ Kyuubi from source
|
|
- `Run tests`_ locally
|
|
- `Submit a pull request`_ through Github
|
|
- Be listed in `Apache Kyuubi contributors`_
|
|
- And most importantly, you can move to the next level and try some tricky issues
|
|
|
|
.. note:: Don't linger too long at this stage.
|
|
:class: dropdown, toggle
|
|
|
|
Help Wanted Issues
|
|
------------------
|
|
|
|
.. image:: https://img.shields.io/github/issues/apache/kyuubi/help%20wanted?color=brightgreen&label=HELP%20WANTED&style=for-the-badge
|
|
:alt: GitHub issues by-label
|
|
:target: `Help Wanted Issues`_
|
|
|
|
Issues that maintainers labeled as help wanted are mostly
|
|
|
|
- sub-tasks of an ongoing shorthanded umbrella
|
|
- non-urgent improvements
|
|
- bug fixes for corner cases
|
|
- feature requests not covered by current technology stack of kyuubi community
|
|
|
|
Since these problems are not urgent, you can take your time when fixing them.
|
|
|
|
.. note:: Help wanted issues may contain easy pickings and tricky ones.
|
|
:class: dropdown, toggle
|
|
|
|
|
|
.. _Good First Issues: https://github.com/apache/kyuubi/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22
|
|
.. _develop environment: idea_setup.html
|
|
.. _Build: build.html
|
|
.. _Run tests: testing.html
|
|
.. _Submit a pull request: https://kyuubi.apache.org/pull_request.html
|
|
.. _Apache Kyuubi contributors: https://github.com/apache/kyuubi/graphs/contributors
|
|
.. _Help Wanted Issues: https://github.com/apache/kyuubi/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22
|
|
|