Skip to content

Commit

Permalink
docs(CONTRIBUTING.md): include node-postgres (#18)
Browse files Browse the repository at this point in the history
* chore: update package description

* chore: improve README.md formatting

* docs(CONTRIBUTING.md): include node-postgres
  • Loading branch information
wellwelwel authored Apr 21, 2024
1 parent 1f68018 commit 038899b
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
Contributions are always welcomed. You can help **AWS SSL Profiles** community in various ways.
Here are our major priorities, listed in order of importance:

- [**Node MySQL**][mysql] and [**MySQL2**][mysql2] API incompatibility fixes
- Adding tests or improving existing ones
- [**mysqljs/mysql**][mysql], [**MySQL2**][mysql2] and [**node-postgres**](https://github.com/brianc/node-postgres) API incompatibility fixes
- Bug Fixes
- Performance improvements
- Adding tests or improving existing ones
- Documentation
- Performance improvements

---

Expand All @@ -33,18 +33,18 @@ Fork this project, create a new branch from `main`, then run `npm ci` to clean i

### Commits and Pull Request Titles

To ensure a clean commit history pattern, please use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) format.
To ensure a clean commit history pattern, please use the [**Conventional Commits**](https://www.conventionalcommits.org/en/v1.0.0/#summary) format.

Prefixes that will trigger a new release version:

- `fix:` for patches, e.g., bug fixes that result in a patch version release.
- `feat:` for new features, e.g., additions that result in a minor version release.
- It's better to discuss an API before actually start implementing it. You can open an issue on Github. We can discuss design of API and implementation ideas.
- It's better to discuss an API before actually start implementing it. You can open an issue on **Github**. We can discuss design of API and implementation ideas.

Examples:

- `fix: message`
- `fix(module): message`
- `fix(scope): message`
- `docs: message`
- etc.

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,4 +132,4 @@ Please check the [**CONTRIBUTING.md**](./CONTRIBUTING.md) for instructions.

## Acknowledgements

[**Contributors**.](https://github.com/mysqljs/aws-ssl-profiles/graphs/contributors)
[**Contributors**](https://github.com/mysqljs/aws-ssl-profiles/graphs/contributors).
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "0.1.0",
"main": "lib/index.js",
"author": "https://github.com/wellwelwel",
"description": "AWS RDS certificates bundles.",
"description": "AWS RDS SSL certificates bundles.",
"license": "MIT",
"repository": {
"type": "git",
Expand Down

0 comments on commit 038899b

Please sign in to comment.