Packages

mailglass

0.1.0
2.4.1 2.4.0 2.3.0 2.2.2 2.2.1 2.1.3 2.0.0 1.11.0 1.10.2 1.10.1 1.9.0 1.8.0 1.7.0 1.6.2 1.6.1 1.5.1 1.5.0 1.4.5 1.4.4 1.4.3 1.4.2 1.4.1 1.3.0 1.2.0 1.0.0 0.3.2 0.1.1 0.1.0

Transactional email framework for Phoenix. Composes on Swoosh

HexDocs

Current section

Files

Jump to
Readme
28 Versions
21 Dependencies
Dependants
Files
Activity
mailglass CONTRIBUTING.md
Raw

CONTRIBUTING.md 

# Contributing to Mailglass



We welcome contributions! Mailglass is developed using a phase-based roadmap found in [`.planning/PROJECT.md`](.planning/PROJECT.md).



## Local Setup



1. Clone the repo.

2. Install dependencies: `mix deps.get`.

3. Setup the test database: `mix ecto.setup` (or `mix ecto.create -r Mailglass.TestRepo`).

4. Run tests: `mix test`.



## Development Workflow



1. Create a branch.

2. Implement your changes and add tests.

3. Run the full verification suite: `mix verify.phase_07`.

4. Submit a PR.



## Commit Guidelines



Use Conventional Commits:

- `feat: ...` for new features

- `fix: ...` for bug fixes

- `docs: ...` for documentation changes

- `chore: ...` for maintenance



## PR Expectations



- All CI checks must pass.

- New features must include documentation and tests.

- Maintain atomic commits.