To start developing on AWM Relayer, you'll need Golang v1.21.12.
- Do not open up a GitHub issue if it relates to a security vulnerability in AWM Relayer, and instead refer to our security policy.
- Check that the issue you're filing doesn't already exist by searching 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 with as much relevant information as possible.
- If you want to start a discussion about the development of a new feature or the modification of an existing one, start a thread under GitHub discussions.
- Post a thread about your idea and why it should be added to AWM Relayer.
- Don't start working on a pull request until you've received positive feedback from the maintainers.
- Open a new GitHub pull request containing your changes.
- All commits must be signed.
- Ensure the PR description clearly describes the problem and solution, and how the change was tested. Include the relevant issue number if applicable.
- If your PR isn't ready to be reviewed just yet, you can open it as a draft to collect early feedback on your changes.
- Once the PR is ready for review, mark it as ready-for-review and request review from one of the maintainers.
- Run the unit tests
./scripts/test.sh- Pull requests will generally not be approved or merged unless they pass CI.
- Ask any question about AWM Relayer under GitHub discussions.