Skip to content

Commit

Permalink
Merge pull request zino-hofmann#1375 from zino-hofmann/macros/docs-on…
Browse files Browse the repository at this point in the history
…-open-pr

docs: update the template for the pull request
  • Loading branch information
vincenzopalazzo authored Aug 30, 2023
2 parents d41edf5 + 956171c commit 0a2fe40
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
Describe the purpose of the pull request.
There are some simple steps to get your PR merged, that are the following:

- Describe your PR and why a maintainer should merge it;
- Put the same description inside the commit body otherwise if we change github hosting you application will be based on a instable source code;
- Write the commit header in the way that it is following these simple rules [1]
- Make sure that your PR will pass the CI
- Wait for an review :smile: that will not happen if one of the previous step is missing.

[1](https://github.com/zino-hofmann/graphql-flutter/blob/main/docs/dev/MAINTAINERS.md#commit-style)

<!--
### Breaking changes
Expand All @@ -14,4 +23,4 @@ Describe the purpose of the pull request.
- Added ... .
- Updated ... .
-->
-->

0 comments on commit 0a2fe40

Please sign in to comment.