You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by zr...@apache.org on 2020/03/06 10:41:42 UTC

[camel] branch master updated: Add more information on contributing

This is an automated email from the ASF dual-hosted git repository.

zregvart pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git


The following commit(s) were added to refs/heads/master by this push:
     new 4c10982  Add more information on contributing
4c10982 is described below

commit 4c109821a93a569f89f0eefaa241d5e7db004ad9
Author: Zoran Regvart <zr...@apache.org>
AuthorDate: Fri Mar 6 11:41:35 2020 +0100

    Add more information on contributing
---
 .../modules/ROOT/pages/contributing.adoc           | 36 +++++++++++++++++++---
 1 file changed, 32 insertions(+), 4 deletions(-)

diff --git a/docs/user-manual/modules/ROOT/pages/contributing.adoc b/docs/user-manual/modules/ROOT/pages/contributing.adoc
index c1a308e..e9da1db 100644
--- a/docs/user-manual/modules/ROOT/pages/contributing.adoc
+++ b/docs/user-manual/modules/ROOT/pages/contributing.adoc
@@ -1,6 +1,10 @@
 = Contributing to Apache Camel
 
-There are many ways you can help make Camel a better piece of software - please dive in and help!
+First of all, thank you for having an interest in contributing to Apache Camel.
+
+Here are some guidelines on how to best approach the Apache Camel community and how to best apply yourself.
+
+There are many ways you can help make Camel better - please dive in and help!
 
 * Try surf the documentation - if somethings confusing or not clear, let us know.
 * Download the code & try it out and see what you think.
@@ -9,6 +13,12 @@ There are many ways you can help make Camel a better piece of software - please
 * If you are a new Camel rider and would like to help us, you can also find https://issues.apache.org/jira/issues/?filter=12348073[some easy to resolve issues] or issues we https://issues.apache.org/jira/issues/?filter=12348074[need help with].
 * Leave a comment on the issue to let us know you are working on it and add yourself as a watcher to get informed about all modifications.
 
+Identify areas you can contribute first. You don't have to be an expert in an area, the Apache Camel developers are available to offer help and guidance.
+
+Introduce yourself on the developer's mailing list (see below), tell us what area of work or problem you wish to address in Camel. Create a draft of your solution, this can be simple 1-2 sentences on the change you wish to make. Try to be as specific as you can: include a short description of your intent, what you tried and what didn't work, or what you need help with. The best way of approaching the developers is by describing what you would like to work on and asking specific questions [...]
+
+We also participate in Google Summer of Code and Outreachy programs, for information about those look at those program websites. If you wish to participate in either of those follow the guidelines and schedule set by those programs. If you're unsure please reach out via official communication channels of those programs, or ask on the developer's mailing list for help.
+
 == Table of Contents
 
 * <<getting-in-touch,Getting in touch>>
@@ -29,11 +39,29 @@ There are many ways you can help make Camel a better piece of software - please
 [#getting-in-touch]
 == Getting in touch
 
+Apache Camel is an Apache Software Foundation project, all communication is done in the open on the project mailing lists. You can https://www.apache.org/foundation/mailinglists.html[read more on the reasoning behind this] to get a better understanding of this.
+
+All communication is subject to the https://www.apache.org/foundation/policies/conduct.html[ASF Code of Conduct].
+
 There are various ways of communicating with the Camel community.
 
-* Join us on the https://camel.apache.org/community/mailing-list/[Mailing Lists] and take part in any conversations
-* Pop by on https://gitter.im/apache/apache-camel[Gitter] chat and say hi
-* Browse through the https://issues.apache.org/jira/browse/CAMEL[issue tracker], look for something interesting and comment there
+For questions and guidance around contributing subscribe to the developer's mailing list by sending an e-mail to dev-subscribe@camel.apache.org.
+
+We can also be reached on the Gitter chat at https://gitter.im/apache/apache-camel/.
+
+We track issues using https://issues.apache.org/jira/browse/CAMEL[ASF Jira], look for https://issues.apache.org/jira/issues/?filter=12348073[some easy to resolve issues] or issues we https://issues.apache.org/jira/issues/?filter=12348074[need help with].
+
+When you're ready to contribute create a Pull request to one of the Camel projects you can find under the Apache organization https://github.com/apache?q=camel[on GitHub].
+
+Expect that your Pull request will receive a review and that you will need to respond and correspond to that via comments at GitHub.
+
+== Your first contribution
+
+Make sure you followed the steps and guidelines outlined in this document. For bigger changes, make sure that you have discussed on the developer's mailing list or in the Jira issue tracker before hand. We love receiving contributions, to get the best response make sure that the reasoning behind the contribution you wish to make is clear: outline the problem and explain your solution for it.
+
+Be mindful of the source checks, formatting and the structure of the git commit message we abide by. This will help you in getting your contribution accepted. Outline any changes you made but are unaware or unsure of any consequences or side effects.
+
+Stay engaged, follow and respond to comments or questions you might be asked.
 
 [#improving-the-documentation]
 == Improving the documentation