Improve templates

This commit is contained in:
Shivam Mathur 2019-11-25 22:06:40 +05:30
parent 970e2d5ebb
commit 7964656607
No known key found for this signature in database
GPG Key ID: 3E13E4C8591ACC2A
6 changed files with 22 additions and 5 deletions

View File

@ -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:

View File

@ -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.

View File

@ -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.
<!-- <!--

View File

@ -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.
<!-- <!--

View File

@ -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.
<!-- <!--

View File

@ -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.
<!-- <!--