Skip to content

Latest commit

 

History

History
43 lines (24 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

43 lines (24 loc) · 1.37 KB
Raw

Contributing

Thanks for choosing to contribute to lewp-rs! This is a summary of all information required to get accepted for a PR. If you have questions or identified missing information, please create an issue so they can be added.

Code conventions

This project follows the standard Rust naming conventions. Make sure that your code is formatted by rustfmt before committing.

Branching setup

The main development takes place in the main branch. Please make sure that your PR goes in there. The main branch is used as base for the release branches.

For the different types of branches the following prefixes are used:

  • f/ for feature branches
  • b/ for bugfix branches
  • r/ for release branches
  • h/ for hotfix branches
  • v is the version tag prefix

Commit messages

The commit messages must follow conventional commits.

Available scopes are:

  • css - for the lewp-css crate

  • selectors - for lewp-selectors crate

  • html - for lewp-html crate

  • lewp - for the main crate

Testing

Please make sure that every commit is a complete one, meaning the code should run as expected. This includes that the following tests

  • cargo test --all-features

  • cargo clippy --all-features

pass.