layout: doc title: “How to contribute” permalink: /docs/contribute.html

Ask questions

The Apache Griffin community is eager to help and to answer your questions. We have a dev/users mailing list.

File a bug report

Please let us know if you experienced a problem with Griffin and file a bug report. Open Apache Griffin’s JIRA and click on the blue Create button at the top. Please give detailed information about the problem you encountered and, if possible, add a description that helps to reproduce the problem.

Propose an improvement or a new feature

Our community is constantly looking for feedback to improve Apache Griffin. If you have an idea how to improve Griffin or have a new feature in mind that would be beneficial for Apache Griffin users, please open an issue in Apache Griffin’s JIRA. The improvement or new feature should be described in appropriate detail and include the scope and its requirements if possible.

We recommend to first reach consensus with the community on whether a new feature is required and how to implement a new feature, before starting with the implementation.

Help others and join the discussions

Most communication in the Apache Griffin community happens on two mailing lists:

The users mailing lists is the place where users of Apache Griffin ask questions and seek for help or advice. Joining the user list and helping other users is a very good way to contribute to Apache Griffin’s community.

The dev mailing list is the place where Griffin developers exchange ideas and discuss new features, upcoming releases, and the development process in general. If you are interested in contributing code to Apache Griffin, you should join this mailing list.

You are welcome to subscribe to both mailing lists.

Contributing to Code

# create jira ticket to specify what you want to do
# Create one new branch for this task

# first fork this to your own repo --
# then clone your own repo to your local workspace
git clone{YOURNAME}/griffin.git

# change code and push to your repository
# please associate related JIRA TICK in your comments
git commit -am "For task GRIFFIN-10 , blabla..."

# Commit and send PR to us
# Apache GRIFFIN PPMC will review and accept your pr as contributing.

How to become a committer

Committers are community members that have write access to the project’s repositories, i.e., they can modify the code, documentation, and website by themselves and also accept other contributions.

There is no strict protocol for becoming a committer. Candidates for new committers are typically people that are active contributors and community members.

Being an active community member means participating on mailing list discussions, helping to answer questions, verifying release candidates, being respectful towards others, and following the meritocratic principles of community management. Since the “Apache Way” has a strong focus on the project community, this part is very important.

Of course, contributing code and documentation to the project is important as well. A good way to start is contributing improvements, new features, or bug fixes. You need to show that you take responsibility for the code that you contribute, add tests and documentation, and help maintaining it.

Candidates for new committers are suggested by current committers or PMC members, and voted upon by the PMC.

If you would like to become a committer, you should engage with the community and start contributing to Apache Griffin in any of the above ways. You might also want to talk to other committers and ask for their advice and guidance.

How to configure committer's mail

Committers are easy to use apache's mail to communicate on the project’s plan, progress, issue etc. When you get your apache account, you should configure a popular mail system to take over it as apache mail system is plain-vanilla for usage.

Here we give configuration guide below to help you take it easily. We use outlook system as sample.

  • Enable setting

  • Add apache mail account

After those settings, you can use your outlook account to send/receive apache mail.