This is an automated email from the ASF dual-hosted git repository.
fanningpj pushed a commit to branch main
in repository
https://gitbox.apache.org/repos/asf/incubator-pekko-persistence-jdbc.git
The following commit(s) were added to refs/heads/main by this push:
new 53e927c Update CONTRIBUTING.md (#77)
53e927c is described below
commit 53e927ccedaa68966cf99cbceab68aeb7b41dd9c
Author: PJ Fanning <[email protected]>
AuthorDate: Mon Aug 14 11:08:09 2023 +0100
Update CONTRIBUTING.md (#77)
* Update CONTRIBUTING.md
* Update CONTRIBUTING.md
---
CONTRIBUTING.md | 14 ++++++--------
1 file changed, 6 insertions(+), 8 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7e3d698..aeaf434 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -18,8 +18,8 @@ For a Pull Request to be considered at all it has to meet
these requirements:
1. Pull Request branch should be given a unique descriptive name that explains
its intent.
2. Code in the branch should live up to the current code standard:
- - Not violate
[DRY](http://programmer.97things.oreilly.com/wiki/index.php/Don%27t_Repeat_Yourself).
- - [Boy Scout
Rule](http://programmer.97things.oreilly.com/wiki/index.php/The_Boy_Scout_Rule)
needs to have been applied.
+ - Not violate [DRY](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself).
+ - [Boy Scout
Rule](https://www.oreilly.com/library/view/97-things-every/9780596809515/ch08.html)
needs to have been applied.
3. Regardless if the code introduces new features or fixes bugs or
regressions, it must have comprehensive tests.
4. The code must be well documented (see the [Documentation](#documentation)
section below).
5. The commit messages must properly describe the changes, see [further
below](#creating-commits-and-writing-commit-messages).
@@ -64,16 +64,14 @@ git config blame.ignoreRevsFile .git-blame-ignore-revs
Follow these guidelines when creating public commits and writing commit
messages.
-1. If your work spans multiple local commits (for example; if you do safe
point commits while working in a feature branch or work in a branch for long
time doing merges/rebases etc.) then please do not commit it all but rewrite
the history by squashing the commits into a single big commit which you write a
good commit message for (like discussed in the following sections). For more
info read this article: [Git
Workflow](https://sandofsky.com/blog/git-workflow.html). Every commit should b
[...]
-
-2. First line should be a descriptive sentence what the commit is doing,
including the ticket number. It should be possible to fully understand what the
commit does—but not necessarily how it does it—by just reading this single
line. We follow the “imperative present tense” style for commit messages ([more
info
here](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)).
+1. First line should be a descriptive sentence what the commit is doing,
including the ticket number. It should be possible to fully understand what the
commit does—but not necessarily how it does it—by just reading this single
line. We follow the “imperative present tense” style for commit messages ([more
info
here](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)).
It is **not ok** to only list the ticket number, type "minor fix" or
similar.
- If the commit is a small fix, then you are done. If not, go to 3.
+ If the commit is a small fix, then you are done. If not, go to 2.
-3. Following the single line description should be a blank line followed by an
enumerated list with the details of the commit.
+2. Following the single line description should be a blank line followed by an
enumerated list with the details of the commit.
-4. Add keywords for your commit (depending on the degree of automation we
reach, the list may change over time):
+3. Add keywords for your commit (depending on the degree of automation we
reach, the list may change over time):
* ``Review by @gituser`` - if you want to notify someone on the team. The
others can, and are encouraged to participate.
Example:
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
