diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..57095c2 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,23 @@ +## Proposed changes + +Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue. + +## Types of changes + +What types of changes does your code introduce to Appium? +_Put an `x` in the boxes that apply_ + +- [ ] Bugfix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Minor Update (if none of the other choices apply) + +## Checklist + +- [ ] I have read the [CONTRIBUTING](https://github.com/mangiucugna/json_repair/blob/master/CONTRIBUTING.md) doc +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] I have run pre-commit and unit tests and all pass locally with my changes + +## Further comments + +If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc... diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 26de1b6..4806553 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,5 @@ # How to contribute +Please make sure to make a change grounded in the reality of production code and not based on theoretical issues that might never arises. The code is complex already as it is. ## Step 1. Open an Issue to describe what you intend to do So that everyone is aware of the intention before getting a surprise PR @@ -7,7 +8,7 @@ So that everyone is aware of the intention before getting a surprise PR Make sure to work in a branch to make it easier to create a new PR. **Important: Update the unit tests each time!** -In fact I'd go out on a limb and say that you should use TDD for this project. +We use TDD for this project. ## Step 3. Run pre-commit Make sure to have pre-commit installed as git hook for this repository and use a virtualenviroment. @@ -15,6 +16,3 @@ This will run all the necessary tests and linters. Saving lots of time to the re ## Step 4. Open a PR to review Refer the Issue number in your PR - -## Step 5. Approval -Profit! diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index d9f15a2..0000000 --- a/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,27 +0,0 @@ -Issue # - ---------- - - - -## What is the current behavior? - - -## What is the new behavior? - - -- -- -- - -## Does this introduce a breaking change? - -- [ ] Yes -- [ ] No - - - - -## Other information - -