mirror of
https://github.com/shivammathur/setup-php.git
synced 2024-11-22 20:01:06 +07:00
Improve templates
This commit is contained in:
parent
970e2d5ebb
commit
7964656607
11
.github/CONTRIBUTING.md
vendored
11
.github/CONTRIBUTING.md
vendored
@ -17,10 +17,11 @@ Due to time constraints, you may not always get a quick response. Please do not
|
|||||||
|
|
||||||
## Coding Guidelines
|
## Coding Guidelines
|
||||||
|
|
||||||
This project comes with a `.prettierrc.json` configuration file. Please run the following command to format the code before committing it.
|
This project comes with `.prettierrc.json` and `eslintrc.json` configuration files. Please run the following commands to format the code before committing it.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ npm run format
|
$ npm run format
|
||||||
|
$ npm run lint
|
||||||
```
|
```
|
||||||
|
|
||||||
## Using setup-php from a Git checkout
|
## Using setup-php from a Git checkout
|
||||||
@ -47,6 +48,14 @@ After following the steps shown above, The `setup-php` tests in the `__tests__`
|
|||||||
$ npm test
|
$ npm test
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Creating a release
|
||||||
|
|
||||||
|
Create a release before you push your changes.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ npm run release
|
||||||
|
```
|
||||||
|
|
||||||
## Reporting issues
|
## Reporting issues
|
||||||
|
|
||||||
Please submit the issue using the appropriate template provided for a bug report or a feature request:
|
Please submit the issue using the appropriate template provided for a bug report or a feature request:
|
||||||
|
2
.github/ISSUE_TEMPLATE/feature_request.md
vendored
2
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@ -8,7 +8,7 @@ assignees: ''
|
|||||||
---
|
---
|
||||||
|
|
||||||
**Is your feature request related to a problem? Please describe.**
|
**Is your feature request related to a problem? Please describe.**
|
||||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
A clear and concise description of what the problem is. Ex. I want to improve [...]
|
||||||
|
|
||||||
**Describe the solution you'd like**
|
**Describe the solution you'd like**
|
||||||
A clear and concise description of what you want to happen.
|
A clear and concise description of what you want to happen.
|
||||||
|
2
.github/PULL_REQUEST_TEMPLATE.md
vendored
2
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -24,6 +24,8 @@ This PR [briefly explain what it does]
|
|||||||
|
|
||||||
- [ ] I have written test cases for the changes in this pull request
|
- [ ] I have written test cases for the changes in this pull request
|
||||||
- [ ] I have run `npm run format` before the commit.
|
- [ ] 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.
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
|
4
.github/PULL_REQUEST_TEMPLATE/FIX.md
vendored
4
.github/PULL_REQUEST_TEMPLATE/FIX.md
vendored
@ -22,8 +22,10 @@ This PR [briefly explain what it does]
|
|||||||
|
|
||||||
> In case this PR introduced TypeScript/JavaScript code changes:
|
> In case this PR introduced TypeScript/JavaScript code changes:
|
||||||
|
|
||||||
- [ ] I have written test cases for the changes in this pull request
|
- [ ] I have written test cases for the changes in this pull request.
|
||||||
- [ ] I have run `npm run format` before the commit.
|
- [ ] 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.
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
|
4
.github/PULL_REQUEST_TEMPLATE/IMPROVEMENT.md
vendored
4
.github/PULL_REQUEST_TEMPLATE/IMPROVEMENT.md
vendored
@ -22,8 +22,10 @@ This PR [briefly explain what it does]
|
|||||||
|
|
||||||
> In case this PR introduced TypeScript/JavaScript code changes:
|
> In case this PR introduced TypeScript/JavaScript code changes:
|
||||||
|
|
||||||
- [ ] I have written test cases for the changes in this pull request
|
- [ ] I have written test cases for the changes in this pull request.
|
||||||
- [ ] I have run `npm run format` before the commit.
|
- [ ] 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.
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
|
4
.github/PULL_REQUEST_TEMPLATE/NEW_FEATURE.md
vendored
4
.github/PULL_REQUEST_TEMPLATE/NEW_FEATURE.md
vendored
@ -22,8 +22,10 @@ This PR [briefly explain what it does]
|
|||||||
|
|
||||||
> In case this PR introduced TypeScript/JavaScript code changes:
|
> In case this PR introduced TypeScript/JavaScript code changes:
|
||||||
|
|
||||||
- [ ] I have written test cases for the changes in this pull request
|
- [ ] I have written test cases for the changes in this pull request.
|
||||||
- [ ] I have run `npm run format` before the commit.
|
- [ ] 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.
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
|
Loading…
Reference in New Issue
Block a user