Skip to content

Commit

Permalink
docs: applied grammar fixes and corrected spelling errors (#18)
Browse files Browse the repository at this point in the history
  • Loading branch information
ivan-penchev authored May 14, 2023
1 parent bff7147 commit b66fdcf
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
22 changes: 11 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,27 @@ This is great that you'd like to contribute to this project. All change requests

## Pull Requests

**Please, make sure you open an issue before starting with a Pull Request, unless it's a typo or a really obvious error.** Pull requests are the best way to propose changes to the specification.
**Please, make sure you open an issue before starting with a Pull Request, unless it's a typo or an obvious error.** Pull requests are the best way to propose changes to the specification.

## Conventional commits

Our repository follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) specification. Releasing to GitHub and NPM is done with the support of [semantic-release](https://semantic-release.gitbook.io/semantic-release/).

Pull requests should have a title that follows the specification, otherwise, merging is blocked. If you are not familiar with the specification simply ask maintainers to modify. You can also use this cheatsheet if you want:
Pull requests should have a title that follows the specification, otherwise, merging is blocked. If you are not familiar with the specification, simply ask maintainers to modify. You can also use this cheat sheet if you want:

- `fix: ` prefix in the title indicates that PR is a bug fix and PATCH release must be triggered.
- `feat: ` prefix in the title indicates that PR is a feature and MINOR release must be triggered.
- `docs: ` prefix in the title indicates that PR is only related to the documentation and there is no need to trigger release.
- `chore: ` prefix in the title indicates that PR is only related to cleanup in the project and there is no need to trigger release.
- `test: ` prefix in the title indicates that PR is only related to tests and there is no need to trigger release.
- `refactor: ` prefix in the title indicates that PR is only related to refactoring and there is no need to trigger release.
- `fix: ` prefix in the title indicates that PR is a bug fix and a PATCH release must be triggered.
- `feat: ` prefix in the title indicates that PR is a feature and a MINOR release must be triggered.
- `docs: ` prefix in the title indicates that PR is only related to the documentation and there is no need to trigger a release.
- `chore: ` prefix in the title indicates that PR is only related to cleanup in the project and there is no need to trigger a release.
- `test: ` prefix in the title indicates that PR is only related to tests and there is no need to trigger a release.
- `refactor: ` prefix in the title indicates that PR is only related to refactoring and there is no need to trigger a release.

What about MAJOR release? just add `!` to the prefix, like `fix!: ` or `refactor!: `
What about a MAJOR release? Just add `!` to the prefix, like `fix!: ` or `refactor!: `

Prefix that follows specification is not enough though. Remember that the title must be clear and descriptive with usage of [imperative mood](https://chris.beams.io/posts/git-commit/#imperative).
Prefix that follows specification is not enough though. Remember that the title must be clear and descriptive with the usage of [imperative mood](https://chris.beams.io/posts/git-commit/#imperative).

## Resources

- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
- [GitHub Help](https://help.github.com)
- [GitHub Help](https://help.github.com)
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ const arn: string = await getValue(bucket.arn);
## Contribution

This project welcomes contributions and suggestions.
Do you want to contribute to the project? Find out how [here](CONTRIBUTING.md).
Would you like to contribute to the project? Learn how to contribute [here](CONTRIBUTING.md).

## License
[Modified Apache 2.0 (Section 6)](LICENSE)
Expand All @@ -58,4 +58,4 @@ Do you want to contribute to the project? Find out how [here](CONTRIBUTING.md).
- [eslint](https://www.npmjs.com/package/eslint): [MIT](https://github.com/eslint/eslint/blob/main/LICENSE)
- [jest](https://www.npmjs.com/package/jest): [MIT](https://github.com/facebook/jest/blob/main/LICENSE)
- [ts-jest](https://www.npmjs.com/package/ts-jest): [MIT](https://github.com/kulshekhar/ts-jest/blob/main/LICENSE.md)
- [typescript](https://www.npmjs.com/package/typescript): [Apache 2.0](https://github.com/microsoft/TypeScript/blob/main/LICENSE.txt)
- [typescript](https://www.npmjs.com/package/typescript): [Apache 2.0](https://github.com/microsoft/TypeScript/blob/main/LICENSE.txt)

0 comments on commit b66fdcf

Please sign in to comment.