diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index e0ee09fd..2a0e4fdb 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -9,11 +9,12 @@ Please note that this project is released with a [Contributor Code of Conduct](C * Fork the project. * Make your bug fix or feature addition. * Add tests for it. This is important so we don't break it in a future version unintentionally. -* Send a pull request to the develop branch. +* If editing the scripts, create a demo integration test. +* Send a pull request to the develop branch with all the details. Please make sure that you have [set up your user name and email address](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup) for use with Git. Strings such as `silly nick name ` look really stupid in the commit history of a project. -Due to time constraints, you may not always get a quick response. Please do not take delays personal and feel free to remind. +Due to time constraints, you may not always get a quick response. Please do not take delays personally and feel free to remind. ## Coding Guidelines @@ -60,4 +61,4 @@ $ npm run release Please submit the issue using the appropriate template provided for a bug report or a feature request: -* [Issues](https://github.com/shivammathur/setup-php/issues) \ No newline at end of file +* [Issues](https://github.com/shivammathur/setup-php/issues) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 7d8f0e8a..24521023 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,23 +1,37 @@ --- name: Bug report -about: Create a report to help us improve +about: Nice, you found a bug! title: '' -labels: '' -assignees: '' +labels: t:bug +assignees: 'shivammathur' --- **Describe the bug** -A clear and concise description of what the bug is. + + +**Runners** + +- [ ] GitHub Hosted +- [ ] Self Hosted + +**Operating systems** + + +**PHP versions** + **To Reproduce** -Please provide the GitHub Action `.yml` file. + **Expected behavior** -A clear and concise description of what you expected to happen. + -**Screenshots** -If applicable, add screenshots to help explain your problem. +**Screenshots/Logs** + **Additional context** -Add any other context about the problem here. + + +**Are you willing to submit a PR?** + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 578141ba..dd7c533d 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,20 +1,23 @@ --- name: Feature request -about: Suggest an idea for this project +about: Suggest a new feature title: '' -labels: '' -assignees: '' +labels: t:enhancement +assignees: 'shivammathur' --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I want to improve [...] +**Describe the feature** + -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +**Underlying issue** + -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +**Describe alternatives** + **Additional context** -Add any other context or screenshots about the feature request here. + + +**Are you willing to submit a PR?** + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f45c003f..62473919 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -7,14 +7,13 @@ labels: bug or enhancement ## A Pull Request should be associated with an Issue. -> We wish to have discussions in Issues. A single issue may be targeted by multiple PRs. -> If you're offering a new feature or fixing anything, we'd like to know beforehand in Issues, -> and potentially we'll be able to point development in a particular direction. +> If you're fixing a bug, adding a new feature or improving something please provide the details in Issues, +> so that the development can be pointed in the intended direction. -Related issue: +Related issue: > Further notes in [Contribution Guidelines](.github/CONTRIBUTING.md) -> Thank you! We are open to PRs, but please understand if for technical reasons we are unable to accept each and any PR +> Thank you for your contribution. ### Description @@ -26,7 +25,12 @@ This PR [briefly explain what it does] - [ ] I have run `npm run format` before the commit. - [ ] I have run `npm run lint` before the commit. - [ ] I have run `npm run release` before the commit. -- [ ] `npm test` returns with no unit test errors. +- [ ] `npm test` returns with no unit test errors and all code covered. + +> In case this PR edits any scripts: + +- [ ] I have checked the edited scripts for syntax. +- [ ] I have tested the changes in an integration test (If yes, provide workflow link). > Further notes in [Contribution Guidelines](.github/CONTRIBUTING.md) -> Thank you! We are open to PRs, but please understand if for technical reasons we are unable to accept each and any PR +> Thank you for your contribution. ### Description @@ -26,7 +25,12 @@ This PR [briefly explain what it does] - [ ] I have run `npm run format` before the commit. - [ ] I have run `npm run lint` before the commit. - [ ] I have run `npm run release` before the commit. -- [ ] `npm test` returns with no unit test errors. +- [ ] `npm test` returns with no unit test errors and all code covered. + +> In case this PR edits any scripts: + +- [ ] I have checked the edited scripts for syntax. +- [ ] I have tested the changes in an integration test (If yes, provide workflow link). > Further notes in [Contribution Guidelines](.github/CONTRIBUTING.md) -> Thank you! We are open to PRs, but please understand if for technical reasons we are unable to accept each and any PR +> Thank you for your contribution. ### Description @@ -26,7 +25,12 @@ This PR [briefly explain what it does] - [ ] I have run `npm run format` before the commit. - [ ] I have run `npm run lint` before the commit. - [ ] I have run `npm run release` before the commit. -- [ ] `npm test` returns with no unit test errors. +- [ ] `npm test` returns with no unit test errors and all code covered. + +> In case this PR edits any scripts: + +- [ ] I have checked the edited scripts for syntax. +- [ ] I have tested the changes in an integration test (If yes, provide workflow link). > Further notes in [Contribution Guidelines](.github/CONTRIBUTING.md) -> Thank you! We are open to PRs, but please understand if for technical reasons we are unable to accept each and any PR +> Thank you for your contribution. ### Description @@ -26,7 +25,12 @@ This PR [briefly explain what it does] - [ ] I have run `npm run format` before the commit. - [ ] I have run `npm run lint` before the commit. - [ ] I have run `npm run release` before the commit. -- [ ] `npm test` returns with no unit test errors. +- [ ] `npm test` returns with no unit test errors and all code covered. + +> In case this PR edits any scripts: + +- [ ] I have checked the edited scripts for syntax. +- [ ] I have tested the changes in an integration test (If yes, provide workflow link).