From commits-return-87119-archive-asf-public=cust-asf.ponee.io@sling.apache.org Tue Jun 30 10:48:48 2020 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [207.244.88.153]) by mx-eu-01.ponee.io (Postfix) with SMTP id 41A1C180643 for ; Tue, 30 Jun 2020 12:48:48 +0200 (CEST) Received: (qmail 37397 invoked by uid 500); 30 Jun 2020 10:48:47 -0000 Mailing-List: contact commits-help@sling.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@sling.apache.org Delivered-To: mailing list commits@sling.apache.org Received: (qmail 37388 invoked by uid 99); 30 Jun 2020 10:48:47 -0000 Received: from ec2-52-202-80-70.compute-1.amazonaws.com (HELO gitbox.apache.org) (52.202.80.70) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 30 Jun 2020 10:48:47 +0000 Received: by gitbox.apache.org (ASF Mail Server at gitbox.apache.org, from userid 33) id 729E9890B8; Tue, 30 Jun 2020 10:48:47 +0000 (UTC) Date: Tue, 30 Jun 2020 10:48:47 +0000 To: "commits@sling.apache.org" Subject: [sling-site] branch master updated: Add Git section to the contributing page MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Message-ID: <159351412740.9175.8794765186680961622@gitbox.apache.org> From: rombert@apache.org X-Git-Host: gitbox.apache.org X-Git-Repo: sling-site X-Git-Refname: refs/heads/master X-Git-Reftype: branch X-Git-Oldrev: 7cfb04e9838d933423425b614a4608ad304961a0 X-Git-Newrev: 14f2b4d269b9f144cebe3b111b85ed4bd17ebc92 X-Git-Rev: 14f2b4d269b9f144cebe3b111b85ed4bd17ebc92 X-Git-NotificationType: ref_changed_plus_diff X-Git-Multimail-Version: 1.5.dev Auto-Submitted: auto-generated 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 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