Skip to content

Contributing

4nass edited this page Aug 19, 2026 · 1 revision

Contributing

Thank you for helping with IdMux. Small, clear changes are easier to review and safer to run.

Before you start

Read the Security page and the main repository's SECURITY.md.

Make a code change

  1. Fork the repository or create a short-lived branch from main.
  2. Make one focused change.
  3. Add or update tests.
  4. Run gofmt, go test -race ./..., go vet ./..., and golangci-lint run.
  5. Open a pull request with a short description and test results.

Keep provider-specific behavior out of the core cookie engine. Do not add password, token, JWT, or business logic to the proxy.

Good pull requests

  • Explain what changed and why.
  • Explain the security impact.
  • Show the checks that passed.
  • Keep the commit history small and clear.
  • Do not include secrets, real cookies, tokens, or customer data.

Wiki changes

The Wiki is for documentation only. Keep code changes in the main repository so they can use pull requests and CI.

Clone this wiki locally