From a8f09dae8a104e2874a3cb6d4b55933d9027a790 Mon Sep 17 00:00:00 2001 From: Justas Bieliauskas Date: Tue, 12 Nov 2019 10:21:01 +0200 Subject: [PATCH 1/3] Restrict issue references. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 6dc0f08..9375253 100644 --- a/README.md +++ b/README.md @@ -40,3 +40,5 @@ To add or remove rules, first [submit an issue](https://github.com/digitronas/ak Clone this repository and run `composer install`. This will install ecs and grumphp. You might have to [bypass grumphp](https://github.com/phpro/grumphp/blob/master/doc/faq.md#how-can-i-bypass-grumphp), since it might not allow you to commit code if there are files that don't meet the standard. Create a pull request to `master` branch. The changes will be merged after they pass code review. + +If an issue should be closed once a pull request is merged, it can be done automatically using Github issue references. Add "Closes #{issue number}" to description. References should not appear in pull request title or any of its commits. From b7c88a50c161285e2a70801b4c92bc82ca167866 Mon Sep 17 00:00:00 2001 From: Justas Bieliauskas Date: Tue, 12 Nov 2019 10:24:01 +0200 Subject: [PATCH 2/3] Add issue references example to README. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9375253..c35d2ff 100644 --- a/README.md +++ b/README.md @@ -41,4 +41,4 @@ Clone this repository and run `composer install`. This will install ecs and grum Create a pull request to `master` branch. The changes will be merged after they pass code review. -If an issue should be closed once a pull request is merged, it can be done automatically using Github issue references. Add "Closes #{issue number}" to description. References should not appear in pull request title or any of its commits. +If an issue should be closed once a pull request is merged, it can be done automatically using Github issue references. Add "Closes #{issue number}" to description ([example](https://github.com/digitronas/akeneo-coding-standard/pull/5)). References should not appear in pull request title or any of its commits. From 1f8d583d0719d446d408317334185e8808151aee Mon Sep 17 00:00:00 2001 From: Justas Bieliauskas Date: Mon, 18 Nov 2019 09:50:04 +0200 Subject: [PATCH 3/3] Allow references in commits. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c35d2ff..86714d9 100644 --- a/README.md +++ b/README.md @@ -41,4 +41,4 @@ Clone this repository and run `composer install`. This will install ecs and grum Create a pull request to `master` branch. The changes will be merged after they pass code review. -If an issue should be closed once a pull request is merged, it can be done automatically using Github issue references. Add "Closes #{issue number}" to description ([example](https://github.com/digitronas/akeneo-coding-standard/pull/5)). References should not appear in pull request title or any of its commits. +If an issue should be closed once a pull request is merged, it can be done automatically using Github issue references. To do that, follow [Github tutorial](https://help.github.com/en/github/managing-your-work-on-github/closing-issues-using-keywords). (here's an [example](https://github.com/digitronas/akeneo-coding-standard/pull/5)). Only pull requests can use references to close issues. Commit messages may contain references, but they must never close issues. Also, *closing* references should be in the pull request description, not the title.