.. 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


Code Contribution Programs
--------------------------

Kyuubi Code Program is a **semi-annual** and **annual** coding program. It's
a 2-month program and the first round will start in October, 2023.

The program is open to all contributors and newbie-friendly as it will provide
a mentor to help you get through the sub-tasks.

You will be rewarded with a Kyuubi SWAG, such as a Kyuubi Contributor T-shirt,
after you complete the program.

.. image:: https://img.shields.io/badge/Kyuubi%20Code%20Program-2024H1-blue?style=for-the-badge

- Status: Planning
- Duration: 2024.02.01 - 2024.04.01
- Sponsors: (keeping seats vacant in anticipation)

.. image:: https://img.shields.io/badge/Kyuubi%20Code%20Program-2023-blue?style=for-the-badge
   :target: https://github.com/apache/kyuubi/issues/5357

- Status: In Progress
- Duration: 2023.10.01 - 2023.12.01
- Sponsors: NetEase

.. _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