This is an automated email from the ASF dual-hosted git repository.
radu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-site.git
The following commit(s) were added to refs/heads/master by this push:
new c910287 SLING-7940 - Improve the Apache Sling website Contributing
page
c910287 is described below
commit c91028754d28cc593b485b855915bead9242f7f2
Author: Radu Cotescu <[email protected]>
AuthorDate: Mon Sep 24 15:23:37 2018 +0200
SLING-7940 - Improve the Apache Sling website Contributing page
---
src/main/jbake/content/contributing.md | 42 +++++++++++++++++++++++++++-------
1 file changed, 34 insertions(+), 8 deletions(-)
diff --git a/src/main/jbake/content/contributing.md
b/src/main/jbake/content/contributing.md
index 84058b9..feea058 100644
--- a/src/main/jbake/content/contributing.md
+++ b/src/main/jbake/content/contributing.md
@@ -4,18 +4,44 @@ status=published
tags=community
~~~~~~
-See [Project Information](/project-information.html) for details about the
tools mentioned below.
+Thanks for choosing to contribute to Apache Sling! The following are a set of
guidelines to follow when contributing to this project.
+
+## Code of Conduct
+
+Being an Apache project, Apache Sling adheres to the Apache Software
Foundation's
+[Code of Conduct](https://www.apache.org/foundation/policies/conduct.html).
+
+## Legal
-Apache Sling is a volunteer effort, so there is always plenty of work that
needs to be accomplished. If you want to help support 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 and/or join the mailing lists.
+Before contributing to the project, please make sure you understand the
+[requirements and implications of contributing to the Apache Software
Foundation](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.
-The Sling project organizes its "to do" list using the JIRA issue tracking
system. Specific items from Sling's JIRA issue tracking system are highlighted
on this page, but are not limited to it. The purpose of the list here is to
highlight issues that are either more important or serve as good entry points
for new contributors.
+## 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 Apache
+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 our
mailing lists.
+
+See [Project Information](/project-information.html) for details about the
tools mentioned below.
-It is important to point out that you do not need to be a programmer to
contribute to Sling. As such, we will break out the list of issues below for
non-programmers and programmers.
+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. 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. 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.
-## Non-Programmers
+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.
-Improve web site or documentation (e.g., create/propose FAQ entries). There is
no specific JIRA issue for this task, but any contributions could be posted as
new JIRA issues for the Documentation component.
+For relatively large contributions (e.g. new modules), we recommend one of the
following two approaches:
-## Programmers
+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 to it as a zip or tar archive.
-Implement support for various rendering technologies in Sling. Examples coming
to mind are JSF and Wicket.
+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 - and don't hesitate to ask on our
+[mailing
lists](http://sling.apache.org/project-information.html#mailing-lists)!
