Work on the code

These pages explain how to work on the code of email-mcp: how to build and test it, which checks run on a pull request, and how a release is made and published. Read them before your first change, and before you make a release.

  • Local development: the make targets, the Go version, what CI (continuous integration: the checks that GitHub runs on each pull request and on each push to main) runs, the rules of the code, the steps to add a tool, a command, a migration or a package, which page of the docs to update and the docs check, and how to build the docs site and the container image.
  • Testing: the kinds of test, the test servers, the end-to-end tests, the build tags and the interop test.
  • Making a release: the setup that is done once, the steps of each release, what to do when a release fails, and how the docs site is published.

Code covered by this page