Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

48 lines (33 loc) · 2.12 KB

Contributing to llvm-plugin-rs

Thank you for taking interest in llvm-plugin-rs!

Found a Bug?

  • Please ensure the bug was not already reported by searching the issue tracker.
  • If you're unable to find an open issue relating to the problem, please file an issue.

Want to Submit a Pull Request?

Please ensure your PR follows these guidelines:

Lint & Formatting

  • You used the rustfmt coding style for any newly added Rust code
  • You used the LLVM coding style for any newly added C++ code
  • You have ran clippy and updated portions of Rust code pertaining to your changes
  • You have ran clang-tidy and updated portions of C++ code pertaining to your changes

Documentation & Tests

  • You added documentation and possibly doc tests to any new functions or types
  • You have updated documentation and doc tests to any modified functions or types as applicable
  • You have added tests to cover your changes
  • All new and existing tests passed

Git Practices

  • You are basing your changes off master
  • You will keep your code reasonably up to date via rebasing over merging whenever possible

Use conventional commits

We use conventional commits and check for them as a lint build step. To help adhere to the format, we recommend to install Commitizen. By using this tool you automatically follow the configuration defined in .cz.toml. Your commit messages should have enough information to help someone reading the CHANGELOG understand what is new just from the title. The summary helps expand on that to provide information that helps provide more context, describes the nature of the problem that the commit is solving and any unintuitive effects of the change. It's rare that code changes can easily communicate intent, so make sure this is clearly documented.

Thanks!