You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by bd...@apache.org on 2018/09/20 10:24:16 UTC

[sling-site] branch issue/SLING-7940 updated: Tweaks to the contributing page

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

bdelacretaz pushed a commit to branch issue/SLING-7940
in repository https://gitbox.apache.org/repos/asf/sling-site.git


The following commit(s) were added to refs/heads/issue/SLING-7940 by this push:
     new 7d25eb7  Tweaks to the contributing page
7d25eb7 is described below

commit 7d25eb7ae063007408ece86943dbf7695fa5fc8f
Author: Bertrand Delacretaz <bd...@apache.org>
AuthorDate: Thu Sep 20 12:23:53 2018 +0200

    Tweaks to the contributing page
---
 src/main/jbake/content/contributing.md | 17 ++++++++---------
 1 file changed, 8 insertions(+), 9 deletions(-)

diff --git a/src/main/jbake/content/contributing.md b/src/main/jbake/content/contributing.md
index 181d435..11e378b 100644
--- a/src/main/jbake/content/contributing.md
+++ b/src/main/jbake/content/contributing.md
@@ -13,29 +13,28 @@ Being an Apache project, Apache Sling adheres to the Apache Software Foundation'
 ## Legal
 
 Before submitting anything to the project, whether we are talking about code, documentation or even website changes, please make sure you
-understand the [legal side of things](https://www.apache.org/foundation/how-it-works/legal.html).
+understand the [legal side of things](https://www.apache.org/foundation/how-it-works/legal.html). An [Apache iCLA](https://www.apache.org/licenses/icla.pdf) is welcome if you start contributing regularly, and required if you later become a committer.
 
 ## How to contribute
 
 Apache Sling is a volunteer effort, so there is always plenty of work that needs to be accomplished. If you want to help supporting Sling,
 this page is intended as a starting point for specific contribution ideas. To further understand how the Sling community operates, refer to
-the [Community Roles and Processes document](https://www.apache.org/foundation/how-it-works.html) and/or join the mailing lists.
+the [Community Roles and Processes document](https://www.apache.org/foundation/how-it-works.html) and/or join our mailing lists.
 
 See [Project Information](/project-information.html) for details about the tools mentioned below.
 
-The Apache Sling project organizes its "to do" list using the JIRA issue tracking system. No matter if you are a programmer or not, it is
+The Apache Sling project organizes its "to do" list using the Apache [JIRA issue tracking system](https://issues.apache.org/jira/browse/SLING). No matter if you are a programmer or not, it is
 probably best to check JIRA first to figure out if the problem you identified is already known or not. If not, please create a JIRA issue in
-which you try to describe to the best of your knowledge the bug that you want to fix or the improvement that you would like to contribute.
+which you try to describe to the best of your knowledge the bug that you want to fix or the improvement that you would like to contribute. There are many recommendations on the Web on how to write a good bug report, like [Haje Jan Kamps' How to write the perfect bug report](https://medium.com/@Haje/how-to-write-the-perfect-bug-report-6430f5a45cd) blog post.
 
-If pull requests are familiar to you, the next step would be opening one against one of the project's modules. More details about how the
+If pull requests are familiar to you, the next step is to open one against one of our modules. More details about how the
 project is structured in terms of repositories can be read on the
 [Getting and Building Sling](/documentation/development/getting-and-building-sling.html) page.
 
-For relatively large contributions (e.g. new modules), we recommend either one of the following two approaches:
+For relatively large contributions (e.g. new modules), we recommend one of the following two approaches:
 
 1. open a JIRA issue and send a pull request to the [Apache Sling Whiteboard project](https://github.com/apache/sling-whiteboard/)
-2. open a JIRA issue and attach your source code as an archive to it
+2. open a JIRA issue and attach your source code to it as a zip or tar archive.
 
 For people who are completely new to contributing to an Apache Software Foundation project, the
-[Get Involved](https://www.apache.org/foundation/getinvolved.html) page provides you with enough resources to understand how the foundation
-works and how its projects are structured.
+[Get Involved](https://www.apache.org/foundation/getinvolved.html) page provides you with enough resources to understand how the foundation works and how its projects are structured - and don't hesitate to ask on our [mailing lists](http://sling.apache.org/project-information.html#mailing-lists)!