diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md index 66dbf480..805acefb 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.md +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -15,7 +15,7 @@ assignees: scolladon For example, "I'm always frustrated when..." --> -### Describe the solution you'd like +### Describe a solution you propose --- @@ -37,5 +37,5 @@ assignees: scolladon diff --git a/.github/ISSUE_TEMPLATE/issue.md b/.github/ISSUE_TEMPLATE/issue.md index c6d2ee4a..487df9cf 100644 --- a/.github/ISSUE_TEMPLATE/issue.md +++ b/.github/ISSUE_TEMPLATE/issue.md @@ -6,11 +6,11 @@ labels: bug assignees: scolladon --- -Issue verification check : +Issue verification check: -- [ ] does the current repository is fully deployable at the commit sha given to the from parameter of the command ? +- [ ] is the current repository fully deployable at the commit SHA provided with the 'from' parameter of the command? -## What is the problem +## What is the problem? --- @@ -18,21 +18,21 @@ Issue verification check : Provide a clear and concise description of what the problem is. --> -### What is parameter and their value you used +### What is the parameter and the value you used with it? -### What is the expected result +### What is the expected result? -### What is the actual result +### What is the actual result? diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 742eb08d..0c764afc 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,7 +2,7 @@ Thanks for sending a pull request! Please make sure you click the link above to view the contribution guidelines, then fill out the blanks below. --> -## What does this pull request contains +## What does this pull request contain? --- @@ -10,12 +10,12 @@ Thanks for sending a pull request! Please make sure you click the link above to Check all that apply --> -- [ ] Added for new features. -- [ ] Changed for changes in existing functionality. -- [ ] Deprecated for soon-to-be removed features. -- [ ] Removed for now removed features. -- [ ] Fixed for any bug fixes. -- [ ] Security in case of vulnerabilities. +- [ ] Added (for new features). +- [ ] Changed (for changes in existing functionality). +- [ ] Deprecated (for soon-to-be removed features). +- [ ] Removed (for now removed features). +- [ ] Fixed (for any bug fixes). +- [ ] Security (for vulnerability fixes). ## Explain your changes @@ -30,23 +30,23 @@ Thanks for sending a pull request! Please make sure you click the link above to --- closes # -- [ ] Jest test to check the fix is applied are added. +- [ ] Jest test added to check the fix is applied. -## Any particular element to being able to test locally +## Any particular element that can be tested locally --- -## Any other comments? +## Any other comments --- diff --git a/PUBLISHING.md b/PUBLISHING.md index 8ef1e537..05208f68 100644 --- a/PUBLISHING.md +++ b/PUBLISHING.md @@ -13,10 +13,10 @@ Here are the steps to publish a version $ yarn release ``` -It will : +This will: - Create a new version based on the commit types from head and package.json version -- Create the changelog with all the commit from head and the last tag version following [keepachangelog](https://keepachangelog.com/en/1.0.0/) +- Create a changelog with all the commit from head and the last tag version following [keepachangelog](https://keepachangelog.com/en/1.0.0/) - Create a new commit with the generated changelog, update package.json - Create a new tag following the semver - Push this tag to the remote