When contributing to this repository, please first open an issue so that the community of contributors to this repository can discuss the suggestion before a change is made.
Commits follow the Angular commit convention.
Run npx cz to commit with prompts to help you write a commit message.
Once you have finished making your changes:
- Make sure that your code satisfies the standards laid out in the testing and coding style section of this document.
- Update README.md with details on any changes to the interface or behavior of the plugin.
- Submit your PR, using the PR template provided to describe the details of your changes.
Then,
- For substantial changes to the plugin, we will try to get at least two community sign-offs and some discussion of the PR before merging.
- For non-controversial or minor PRs (e.g. phrasing updates in the documentation, minor refactoring of constants), one approval will be sufficient to move forward.
- A contributor with push access to the repo will merge the PR after all tests and fixes have occured.
- A new release will be published (if appropriate).
Please read our testing guide and ensure any changes are covered by unit tests, and integration tests if applicable.
This repository uses prettier to enforce a uniform coding style. You may install an editor plugin for prettier, but code will also be auto-formatted via a git hook whenever you commit code.
Please be polite and respectful in all your communication and actions towards others in the serverless-finch community.