Skip to content

Restrict the usage of issue references #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Restrict the usage of issue references #25

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a8f09da
Restrict issue references.
jbieliauskas Nov 12, 2019
b7c88a5
Add issue references example to README.
jbieliauskas Nov 12, 2019
1f8d583
Allow references in commits.
jbieliauskas Nov 18, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. 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.