Contributions are always welcomed. You can help AWS SSL Profiles community in various ways. Here are our major priorities, listed in order of importance:
- mysqljs/mysql, MySQL2 and node-postgres API incompatibility fixes
- Bug Fixes
- Adding tests or improving existing ones
- Documentation
- Performance improvements
You will need these tools installed on your system:
Fork this project, create a new branch from main, then run npm ci to clean install the node modules.
To ensure a clean commit history pattern, please use the Conventional Commits 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.
Examples:
fix: messagefix(scope): messagedocs: message- etc.
Where possible, provide an error test case that your fix covers.
Please ensure test cases to cover your features.
npm run testYou can also run all the tests that will be executed in the CI, such as build, lint, etc., by running:
npm run test:ciTip
You can also run a single test by performing npx tsx test/path-to-test-file.test.ts to debug easily.