First off, thank you for considering contributing to the Serverless Agent Pattern project! We appreciate your time and effort.
There are many ways you can contribute to this project:
- Ensure the bug was not already reported by searching on GitHub under Issues.
- If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
- Open a new issue with your suggestion. Provide a clear description of the enhancement and its potential benefits.
- Explain why this enhancement would be useful to other users.
- Fork the repository and create your branch from
main. - Ensure your code lints (
pnpm lint). - Make sure your code builds (
pnpm build). - If you've added code that should be tested, add tests.
- Ensure the test suite passes (
pnpm test). - Issue that pull request!
- Follow the existing code style.
- Add JSDoc comments for new functions or complex logic.
- Ensure your code is well-formatted.
This project and everyone participating in it is governed by the Code of Conduct. Please adhere to it in all your interactions with the project.
We look forward to your contributions!