You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ra...@apache.org on 2018/09/19 14:47:41 UTC

[sling-site] 01/01: SLING-7940 - Improve the Apache Sling website Contributing page

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

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

commit 430831c722febd21496c30b8d8a43284ea463527
Author: Radu Cotescu <ra...@apache.org>
AuthorDate: Wed Sep 19 16:37:24 2018 +0200

    SLING-7940 - Improve the Apache Sling website Contributing page
---
 src/main/jbake/content/contributing.md | 36 ++++++++++++++++++++++++++--------
 1 file changed, 28 insertions(+), 8 deletions(-)

diff --git a/src/main/jbake/content/contributing.md b/src/main/jbake/content/contributing.md
index 84058b9..181d435 100644
--- a/src/main/jbake/content/contributing.md
+++ b/src/main/jbake/content/contributing.md
@@ -4,18 +4,38 @@ 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 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).
 
-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 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.
+
+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 JIRA issue tracking system. 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.
 
-## Non-Programmers
+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
+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 either 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 as an archive to it
 
-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.