Skip to content

Commit

Permalink
add contributors guide
Browse files Browse the repository at this point in the history
  • Loading branch information
andygrove committed Apr 26, 2024
1 parent 8485558 commit a4095af
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 2 deletions.
52 changes: 52 additions & 0 deletions docs/source/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<!---
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 DataFusion Comet

We welcome contributions to Comet in many areas, and encourage new contributors to get involved.

Here are some areas where you can help:

- Testing Comet with existing Spark jobs and reporting issues for any bugs or performance issues
- Contributing code to support Spark expressions, operators, and data types that are not currently supported
- Reviewing pull requests and helping to test new features for correctness and performance
- Improving documentation

## Finding issues to work on

We maintain a list of good first issues in GitHub [here](https://github.com/apache/datafusion-comet/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).

## Reporting issues

We use [GitHub issues](https://github.com/apache/datafusion-comet/issues) for bug reports and feature requests.

## Asking for Help

The Comet project uses the same Slack and Discord channels as the main Apache DataFusion project. See details at
[Apache DataFusion Communications]. There are dedicated Comet channels in both Slack and Discord.

## Regular public meetings

The Comet contributors hold regular video calls where new and current contributors are welcome to ask questions and
coordinate on issues that they are working on.

See the [Apache DataFusion Comet community meeting] Google document for more information.

[Apache DataFusion Communications]: https://datafusion.apache.org/contributor-guide/communication.html
[Apache DataFusion Comet community meeting]: https://docs.google.com/document/d/1NBpkIAuU7O9h8Br5CbFksDhX-L9TyO9wmGLPMe0Plc8/edit?usp=sharing
13 changes: 11 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,23 @@ as a native runtime to achieve improvement in terms of query efficiency and quer
This documentation site is currently being developed. The most up-to-date documentation can be found in the
GitHub repository at https://github.com/apache/datafusion-comet.

If you would like to contribute to Comet, please see our <a href="contributing/">contributing guide</a>.

.. _toc.links:
.. toctree::
:maxdepth: 1
:caption: Project Links
:caption: Contributor Guide

compatibility
Contributing <contributing>
Github and Issue Tracker <https://github.com/apache/datafusion-comet>

.. _toc.links:
.. toctree::
:maxdepth: 1
:caption: User Guide

compatibility

.. _toc.asf-links:
.. toctree::
:maxdepth: 1
Expand Down

0 comments on commit a4095af

Please sign in to comment.