You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by dm...@apache.org on 2020/02/27 22:08:29 UTC
svn commit: r1874595 -
/ignite/site/branches/ignite-redisign/community/contribute.html
Author: dmagda
Date: Thu Feb 27 22:08:29 2020
New Revision: 1874595
URL: http://svn.apache.org/viewvc?rev=1874595&view=rev
Log:
updated contribution guidelines
Modified:
ignite/site/branches/ignite-redisign/community/contribute.html
Modified: ignite/site/branches/ignite-redisign/community/contribute.html
URL: http://svn.apache.org/viewvc/ignite/site/branches/ignite-redisign/community/contribute.html?rev=1874595&r1=1874594&r2=1874595&view=diff
==============================================================================
--- ignite/site/branches/ignite-redisign/community/contribute.html (original)
+++ ignite/site/branches/ignite-redisign/community/contribute.html Thu Feb 27 22:08:29 2020
@@ -52,43 +52,127 @@ under the License.
<section id="contribute" class="page-section">
<h1 class="first">Contribute to Apache Ignite</h1>
<p>
- Before you get involved in Apache Ignite development, please sign up to the
- <a href="mailto:dev@ignite.apache.org">dev mailing list</a> and say "Hello" to everyone in
- the community. Tell us as much as you can about your areas of expertise mentioning how
- exactly you would like to contribute. We are a friendly and inclusive community and will try to
- simplify your "onboarding" considering your strengths or areas of interest.
+ This guide discusses various types of contribution to Apache Ignite extending generic ideas
+ of the <a href="https://community.apache.org/gettingStarted/101.html" target="_blank">ASF Getting
+ Started</a>. Contributing to Ignite doesnât just mean writing code. Helping new users on the mailing
+ list and improving documentation are also important. In fact, proposing significant code changes usually requires
+ first gaining experience and credibility within the community by helping in other ways.
+ </p>
+ <p>
+ The guide organizes contributions in order that should be considered by new contributors
+ who intend to get involved long-term. Build some track record of helping others, become more
+ experienced with Ignite rather than solely focusing on code pull-requests.
+ </p>
+ <p>
+ Also, our communication and collaboration are based on
+ <a href="http://www.apache.org/theapacheway/index.html" target="_blank">The Apache Way</a> that helps
+ us, as a group of professionals, drive the project forward in a respectful and inclusive way.
+ </p>
+
+ <h2>Getting Started</h2>
+ <p>
+ The first thing to do is to sign up to the <a href="mailto:dev@ignite.apache.org">dev mailing
+ list</a> and say "Hello" to everyone in the community. Tell us as much as you can about your areas of
+ expertise mentioning how exactly you would like to contribute. We are a friendly and inclusive
+ community and will try to simplify your "onboarding" considering your strengths or areas of interest.
Also, make sure to share your JIRA ID in the same email
(<a href="https://issues.apache.org/jira/projects/IGNITE"target="_blank">create a new one</a>
if you don't have an ASF JIRA account yet). One of our community members will add you to
- the contributors' list and you will be able to go ahead and book Ignite tasks you'd like to work on.
- </li>
+ the contributors' list.
</p>
<p>
- Again, a small formality, you need to subscribe to the dev list before sending emails to it. To
- subscribe, send an empty email to <a
- href="mailto:dev-subscribe@ignite.apache.org?subject=Subscribe"><nobr>dev-subscribe@ignite.apache.org</nobr></a>
- and follow simple instructions in the reply.
- </p>
- <p>
- Finally, check <a href="https://cwiki.apache.org/confluence/display/IGNITE/How+to+Collaborate" target="_blank">
+ Last, check <a href="https://cwiki.apache.org/confluence/display/IGNITE/How+to+Collaborate" target="_blank">
How to Collaborate</a> page for more details on various communication channels used by the community
members. Even though most of the discussions take place on the dev list, we hang out in Slack.
</p>
- <div class="page-heading">Contribution Process</div>
+
+ <h2>Contribute by Helping Others</h2>
+
<p>
- Before you start contributing, spend some time to get to know our
+ A great way to contribute to Ignite and to get more practical experience is to help answer
+ user questions on the user@ignite.apache.org mailing list or on StackOverflow. Ignite users ask dozens
+ of questions daily; taking a few minutes to help answer a question or troubleshoot an issue is a very
+ valuable contribution to the project and community success.
+ </p>
+ <p>
+ Subscribe to the <a href="/community/resources.html">user list and set up StackOverflow notifications</a>
+ to stay up to date on whatâs happening in Ignite. Answering questions is an excellent and visible way
+ to help the community, which also demonstrates your expertise.
+ </p>
+
+ <h2>Contribute Documentation Changes</h2>
+ <p>
+ Technical documentation and API references such as JavaDocs are as valuable as contribution of bug
+ fixes or features. Ignite documentation is an integral part of the project that educates Ignite users
+ about Ignite capabilities, configuration techniques, optimization aspects and many other areas they need
+ to know to deploy Ignite successfully in production. Documentation and APIs are the faces of the
+ project and the community puts a lot of efforts maintaining them properly and professionally.
+ </p>
+ <p>
+ Code changes contribution is not the only way to become an Ignite committer. Help the community to
+ produce and maintain the documentation pages or API references, edit and correct existing content, stay
+ active on the user and dev mailing lists, and you'll become a committer inevitably.
+ </p>
+ <p>
+
+ </p>
+ <ul class="page-list">
+ <li>
+ Come across a misprint or unclear documentation section? Use "Suggest Edits" feature of
+ our <a href="https://apacheignite.readme.io/docs" target="_blank"> main documentation portal</a> to propose a
+ change.
+ </li>
+ <li>
+ Select any <a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20IGNITE%20AND%20resolution%20%3D%20Unresolved%20AND%20status%20not%20in%20(closed%2C%20resolved)%20and%20component%20%3D%20documentation%20%20ORDER%20BY%20priority%20DESC%2C%20updated%20DESC" target="_blank">
+ open documentation ticket</a> and start working on it. Use "Suggest Edits" to submit improvements.
+ </li>
+ <li>
+ To propose a change to <a href="/docs-and-apis.html#apis">API references</a> such as JavaDocs,
+ follow the process similar to the code contribution described below -- update the docs and send a
+ pull-request.
+ </li>
+ </ul>
+
+ <h2>Code Contributions</h2>
+ <p>
+ Before you start with code contributions, get to know our
<a href="https://cwiki.apache.org/confluence/display/IGNITE/How+to+Contribute" target="_blank">Contribution and
- Development</a> process. In short, our communication and collaboration are based on
- <a href="http://www.apache.org/theapacheway/index.html" target="_blank">The Apache Way</a> that helps
- us, as a group of professionals, drive the project forward in a respectful and inclusive way.
+ Development</a> process.
+ </p>
+
+ <div class="page-heading">Extensions and Integrations Contribution</div>
+ <p>
+ Ignite is used together with a huge selection of libraries and
+ frameworks, and some of them are officially supported by the community. While some of the
+ existing integrations such as with Spark, Spring Data or Hibernate still reside in the primary Ignite
+ repository, they all will be eventually moved to Ignite Extensions repository. New integrations are
+ accepted to the Extensions repository only.
</p>
+ <p>
+ Feel free to contribute a new extension to Ignite or select an open ticket to help improve existing
+ integrations:
+ </p>
+ <ul>
+ <li>
+ <a href="https://issues.apache.org/jira/browse/IGNITE-8382?jql=project%20%3D%20Ignite%20and%20summary%20~%20%22spring%22%20and%20status%20not%20in%20(Resolved%2C%20Closed)" target="_blank">
+ Spring Framework</a> integrations.
+ </li>
+ <li>
+ <a href="https://issues.apache.org/jira/browse/IGNITE-12054?jql=project%20%3D%20Ignite%20and%20summary%20~%20%22spark%22%20and%20status%20not%20in%20(Resolved%2C%20Closed)" target="_blank">
+ Apache Spark</a> integration.
+ </li>
+ <li>
+ <a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20IGNITE%20AND%20component%20in%20(Integrations)%20and%20status%20%3D%20OPEN"
+ target="_blank">All other</a> integrations.
+ </li>
+ </ul>
- <div class="page-heading">Pick a Ticket</div>
+ <div class="page-heading">Contribute to Ignite core</div>
<p>
- Select a task of your interest and finish the first contributions! Start paving a path to the role of an
- Apache Ignite committer! To simplify your first choice, we prepared a list of tickets of easy and
- moderate complexity:
+ If you are willing to contribute to the core components of Ignite then consider one of the tickets
+ below. Those are the tickets of easy and moderate complexity community members prepared for you to
+ simplify your start:
</p>
<ul class="page-list">
<li>
@@ -112,11 +196,6 @@ under the License.
this filter</a> for the selection of the first tasks.
</li>
<li>
- Are you willing to integrate Ignite with other frameworks and technologies? Check one of
- <a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20IGNITE%20AND%20component%20in%20(Integrations)%20and%20status%20%3D%20OPEN"
- target="_blank">these tickets </a> or propose your integration.
- </li>
- <li>
Curious in distributed data structures?
<a
href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20IGNITE%20AND%20component%20in%20(%22data%20structures%22)%20and%20status%20%3D%20OPEN" target="_blank">
@@ -129,7 +208,7 @@ under the License.
discussions on the dev list or simply email us.
</p>
- <div class="page-heading">Become a Committer and PMC Member</div>
+ <h2>Become a Committer and PMC Member</h2>
<p>
We love contributions and gladly promote active contributors to committers and PMC members! If you
are new to Apache Software Foundation then Ignite will be an excellent
@@ -141,7 +220,7 @@ under the License.
meritocratic principles of community management.
</p>
<p>
- Of course, code contributions are also important. Once you make a few code contributions,
+ Of course, code and documentation contributions are also important. Once you make a few of them,
you will become eligible to join Ignite committers, and possibly Ignite PMC.
Candidates for new committers or PMC members are suggested by the current committers, mentors, or
PMC members, and then must be approved by the PMC voting process.