Contributing to ExMaude

View Source

Thank you for your interest in contributing to ExMaude!

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/ex_maude.git
  3. Install dependencies: mix setup
  4. Create a feature branch: git checkout -b feature/amazing-feature

Development

mix setup          # Install dependencies
mix test           # Run tests
mix lint           # Run linters (format, credo, dialyzer)
mix check          # Run all quality checks
mix docs           # Generate documentation
mix bench          # Run benchmarks

Running Integration Tests

Integration tests require Maude to be installed:

mix maude.install                    # Install Maude
mix test --include integration       # Run all tests including integration

Code Quality

Before submitting a PR, ensure:

  • [ ] All tests pass: mix test
  • [ ] Code is formatted: mix format
  • [ ] Credo passes: mix credo --strict
  • [ ] Dialyzer passes: mix dialyzer
  • [ ] Documentation is updated

Commit Messages

Follow Conventional Commits:

  • feat: new features
  • fix: bug fixes
  • docs: documentation changes
  • refactor: code refactoring
  • test: test additions or changes
  • chore: maintenance tasks

Pull Request Process

  1. Ensure your code follows the project style
  2. Update documentation as needed
  3. Add tests for new functionality
  4. Update CHANGELOG.md with your changes
  5. Submit a PR with a clear description

Releases

Releases are managed by maintainers using git_ops:

  1. Ensure all tests pass: mix check
  2. Run mix release (alias for mix git_ops.release) — updates changelog, bumps version, commits, and tags
  3. Push with tags: git push --follow-tags
  4. CI will publish to Hex.pm on the v* tag

Questions?

Open an issue for questions or discussions.