soenkeliebau commented on a change in pull request #20: TRAINING-10: Create contributors guide URL: https://github.com/apache/incubator-training/pull/20#discussion_r287146297
########## File path: site/src/site/asciidoc/developers/contributing.adoc ########## @@ -20,84 +20,58 @@ === Forms of contribution -There are multiple forms in which you can become involved with the Apache Training project. +The Apache Training (Incubating) project welcomes contributions in all forms, sizes, and shapes. +Below you can find a small list of possible ways that you can contribute if you have some spare time and want to get involved. -These usually are, but are not limited to: +This is by no means a finite list, there are without doubt dozens of other useful ways that you can pick, please do not let this limit your creativity! -- Submitting Pull Requests +- Adding to the webpage - Filing Bug-Reports +- Converting donated materials - Active communication on our mailing lists - Promoting the project (articles, blog posts, talks at conferences) -- Documentation +- Writing documentation -=== Pull-Requests +=== Finding a Project +If you want to get involved, but do not have a specific project in mind please feel free to check our issue tracker for https://issues.apache.org/Jira/issues/?jql=project%20%3D%20TRAINING%20AND%20labels%20%3D%20beginner%20AND%20assignee%20in%20(EMPTY)[unassigned issues with the _beginner_ label]. These should be good candidates to get your feet wet and gather some experience before tackling larger issues. -The simplest way to submit code changes is via a GitHub pull-request. +If nothing catches your eye and you come up with something that you want to work on by yourself, please do share your intent by either posting on the mailing list or creating an issue, as this allows us to limit duplication of effort as much as possible. -In order to do this first create a GitHub account and sign into your account. +=== Code Contributions +Many of the actions listed above will take the form of contributions to the git repository, for which we have defined a few basic guidelines to ensure we can all collaborate effectively. +Code contributions can take two forms, you can either create a pull request on github or directly attach patch files to a Jira issue for review. -After that's done, please go to our https://github.com/apache/incubator-training[GitHub site] and create a so-called `Fork`. +A Jira ticket and a pull request are not mutually exclusive, in fact, we encourage people to create both, first a Jira to discuss the issue, task, improvement in general and later on a pull request for actual implementation discussions. Review comment: done ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
