This is an automated email from the ASF dual-hosted git repository.
joerghoh 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 2db3d73 update the contribution page (#78)
2db3d73 is described below
commit 2db3d733a04e6b8ea2d312a52492be6f086c8518
Author: Jörg Hoh <[email protected]>
AuthorDate: Fri Jan 28 10:26:12 2022 +0100
update the contribution page (#78)
* reorganizing the contribution section, mention the good-first-issue
marked issues
---
src/main/jbake/content/contributing.md | 37 +++++++++++++---------------------
src/main/jbake/templates/downloads.tpl | 2 +-
2 files changed, 15 insertions(+), 24 deletions(-)
diff --git a/src/main/jbake/content/contributing.md
b/src/main/jbake/content/contributing.md
index 72885fd..a1ccaf4 100644
--- a/src/main/jbake/content/contributing.md
+++ b/src/main/jbake/content/contributing.md
@@ -1,4 +1,4 @@
-title=Contributing
+title=Contributing
type=page
status=published
tags=community
@@ -16,30 +16,24 @@ Being an Apache project, Apache Sling adheres to the Apache
Software Foundation'
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.
+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 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.
+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](http://sling.apache.org/project-information.html#mailing-lists).
+
+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)!
See [Project Information](/project-information.html) for details about the
tools mentioned below.
-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.
+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 recommendati [...]
+
+If pull requests are familiar to you, the next step is to open one against
[one of our
modules](https://github.com/apache/?q=sling&type=all&language=&sort=). If
creating a pull request from your own repository, setting the _[allow edits
from
maintainers](https://docs.github.com/en/github/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)_
option is convenient as it allows us to update your fork as the pull request
evolves.
-If pull requests are familiar to you, the next step is to open one against one
of our modules. If creating a pull request from your
-own repository, setting the
-_[allow edits from
maintainers](https://docs.github.com/en/github/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)_
-option is convenient as it allows us to update your fork as the pull request
evolves.
+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.
-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.
+If you want to get involved into Sling development, we marked a number of
issues in JIRA with the label
["good-first-issue"](https://issues.apache.org/jira/browse/SLING-5767?jql=project%20%3D%20SLING%20AND%20status%20%3D%20Open%20AND%20labels%20in%20(easy-first-issue%2C%20good-first-issue));
we consider them a good starting point into Sling development. Just assign the
ticket to you and create a pull request to address it. We provide you feedback
and help you to get your contribution int [...]
For relatively large contributions (e.g. new modules), we recommend one of the
following two approaches:
@@ -49,10 +43,7 @@ For relatively large contributions (e.g. new modules), we
recommend one of the f
In any case it's good to discuss larger contributions on our developers
mailing list before starting their implementation, to help align
your goals and software design with the Sling community.
-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)!
+
### Git
@@ -82,13 +73,13 @@ In case your changes are more far-reaching and the module
you are contributing t
[Sling Starter](https://github.com/apache/sling-org-apache-sling-starter), it
is a good idea to
also run the Sling Starter integration tests. This can be achieved by doing
the following:
-* Check out the [Sling
Starter](https://github.com/apache/sling-org-apache-sling-starter) and
+* Check out the [Sling
Starter](https://github.com/apache/sling-org-apache-sling-starter) and
[Sling Starter Integration
Tests](https://github.com/apache/sling-org-apache-sling-launchpad-testing)
projects. This step can be skipped if you have followed the steps to
checkout all Sling repositories
as documented at [Getting and Building
Sling](/documentation/development/getting-and-building-sling.html#getting-the-sling-source)
* Use the latest version of the bundle(s) you changed in the Sling Starter.
Running `git grep ${ARTIFACT_ID}`
will indicate the potential places where you need to make changes
-* Run `mvn clean install` in the Sling Starter checkout. This runs a set of
Smoke tests and allows the
+* Run `mvn clean install` in the Sling Starter checkout. This runs a set of
Smoke tests and allows the
integration tests to use the version of the starter that you just built
* Run `mvn clean install` in the Sling Starter Integration Tests checkout
diff --git a/src/main/jbake/templates/downloads.tpl
b/src/main/jbake/templates/downloads.tpl
index 095b8a7..af59dff 100644
--- a/src/main/jbake/templates/downloads.tpl
+++ b/src/main/jbake/templates/downloads.tpl
@@ -218,7 +218,7 @@ def bundles=[
"Resource Inventory|org.apache.sling.resource.inventory|1.0.8|Y|jar",
"Resource Merger|org.apache.sling.resourcemerger|1.4.0|Y|jar",
"Resource Presence|org.apache.sling.resource.presence|0.0.2|Y|jar",
- "Resource Resolver|org.apache.sling.resourceresolver|1.8.0|Y|jar",
+ "Resource Resolver|org.apache.sling.resourceresolver|1.8.2|Y|jar",
"Rewriter|org.apache.sling.rewriter|1.3.0|Y|jar",
"Failing Server-Side
Tests|org.apache.sling.testing.samples.failingtests|1.0.6|N|jar",
"SAML2 Service Provider|org.apache.sling.auth.saml2|0.2.6|Y|jar",
