-
Notifications
You must be signed in to change notification settings - Fork 126
Working on a Pull Request
The following steps outline the common workflow around pull requests in this repository:
-
Create your pull request as early as possible to already get feedback while work is still in progress.
-
Prefix the title of your pull request with
[WIP]
while you are still working on the pull request. -
Once your pull request is ready for review, remove the
[WIP]
prefix from the title and leave a comment possibly mentioning one of the maintainers' usernames to request a review. -
Once your pull request has been reviewed, it will either be merged or changes will be requested. In the latter case, one of the maintainers will add the
[WIP]
prefix to the title again.
The last two steps repeat until the pull request is merged or closed.
-
Do not modify
CHANGELOG.md
orlib/pageflow/version.rb
inside pull requests. -
If your pull requests contains breaking changes or requires manual update steps in host applications, include detailed instructions in the description of the pull request that can be included in the changelog later on.
-
Do not modify locale files like
config/locales/en.yml
. Instead follow the instructions for adding and deleting translation keys. -
There should be no Hound warnings. The linter config is work in progress, though. So do not blindly follow suggestions. Suggest a linter config change where it makes sense.