sling-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From romb...@apache.org
Subject [sling-site] branch master updated: Add Git section to the contributing page
Date Tue, 30 Jun 2020 10:48:47 GMT
This is an automated email from the ASF dual-hosted git repository.

rombert 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 14f2b4d  Add Git section to the contributing page
14f2b4d is described below

commit 14f2b4d269b9f144cebe3b111b85ed4bd17ebc92
Author: Robert Munteanu <rombert@apache.org>
AuthorDate: Tue Jun 30 12:47:56 2020 +0200

    Add Git section to the contributing page
---
 src/main/jbake/content/contributing.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/src/main/jbake/content/contributing.md b/src/main/jbake/content/contributing.md
index 1296751..108b7bd 100644
--- a/src/main/jbake/content/contributing.md
+++ b/src/main/jbake/content/contributing.md
@@ -47,6 +47,26 @@ For people who are completely new to contributing to an Apache Software
Foundati
 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
+
+#### Commit meesages
+
+For non-trivial commits a Jira issue is required. Once the Jira issue is created, the commit
message must include the Jira issue key
+and the summary as the first line, followed by an optional description of the fix. For example:
+
+```
+SLING-1234 - Fix NPE in FooImpl
+
+When the FooImpl is reconfigured the bar field can be set to null, so check
+against null values.
+```
+
+#### Pull request changes
+
+When iterating on a GitHub pull request a single commit can receive multiple follow-up fixes.
To help preserve
+a linear history and to make changes easy to follow, please squash the changes in a single
commit and force-push
+to the GitHub branch.
+
 ### Testing
 
 Each Sling module comes with an automated build, usually based on Apache Maven. Your change
should be covered


Mime
View raw message