Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
99 lines (62 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

99 lines (62 loc) · 2.77 KB

Contributing

Thank you for considering contributing to SensApp! We welcome contributions, though it has never happened yet.

Discuss Changes

For significant changes, please open an issue first to discuss what you would like to change. This helps us align your contributions with our project goals.

Pre-commits hooks

Please use pre-commits hooks to check your changes locally. Your change will also be checked by the continuous integration (CI) pipeline, but it is faster to catch errors locally before pushing your changes.

pip install pre-commit
pre-commit install
pre-commit install --hook-type commit-msg

Language

We use Rust.

Code Style

We follow the Rust Style Guide.

Tests

Update tests as appropriate. New features should come with additional tests.

Documentation

Documentation: Update the README.md or other documentation with details of changes to the interface or additional features.

Issues

Make sure you use the latest version of SensApp and please include enough information about the issue. The more information you provide, the easier it is to reproduce the issue and to fix it.

Pull Merge Requests

You are not allowed to push to the main branch. Please create a merge request instead.

Please do NOT squash your merge requests. You are welcome to organise and clean your commits first, but we want to keep the commit history.

Avoid merging your own pull requests without a review. Do not merge a pull request with failing tests.

Commit Messages

We use Conventional Commits.

<type>[(optional scope)]: <description>

[optional body]

[optional footer(s)]

Examples:

fix: prevent infinite loop when it rains
docs(architecture): correct spelling of banana

Valid types are: fix, feat, chore, docs, style, refactor, perf, test, revert, ci, and build.

To please the gitmoji enthousiasts, unicode emojis are allowed but not enforced. Commit messages with emojis still must respect the conventional commit format.

Examples:

fix: 🐛 prevent infinite loop when it rains
docs(architecture): 📝 correct spelling of banana

Useful Commands

# Build
cargo build

# Test
cargo test
cargo make test-all         # all storage backends
cargo make test-local-matrix # all local backends via Docker Compose (no BigQuery)

# Lint (format + clippy)
cargo make lint
cargo make lint-all         # all storage backends

# Full validation
cargo make check-all        # working features (postgres + sqlite)
cargo make check-all-storage # all storage backends
cargo make check-local-matrix # all local backends via Docker Compose (no BigQuery)

# Setup (runs migrations)
cargo make setup-dev