Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

63 lines (42 loc) · 1.94 KB
Raw

Contributing to linurgy

Thank you very much for considering to contribute to this project!

We welcome any form of contribution:

  • New issues (feature requests, bug reports, questions, ideas, ...)
  • Pull requests (documentation improvements, code improvements, new features, ...)

Note: Before you take the time to open a pull request, please open an issue first.

CI

Our continuous integration workflow checks all pull requests to ensure:

  • All tests pass on stable and Rust 1.32.0
  • No clippy errors or warnings
  • Rustfmt is adhered to

To check this on your own machine run cargo test, cargo clippy, and cargo fmt --check.

MSRV

The current minimum supported Rust version of this project is 1.32.0. If your change requires a newer version we are open to upgrading.

Commit messages

Please try to keep your git commit messages in line with Conventional Commits.

For example:

feat: non-allocating editor

Add an entry to the changelog

If your contribution changes the behavior of linurgy (as opposed to a typo-fix in the documentation), please update the CHANGELOG.md file and describe your changes. This makes the release process much easier and therefore helps to get your changes into a new linurgy release faster.

The top of the CHANGELOG contains an "unreleased" section with a few subsections (Added, Changed, Testing, …). Please add your entry to the subsection that best describes your change. If a relevant subsection does not yet exist, please create it.

Entries follow this format:

### Changed

- Short description of what has been changed, see #123 (@user).
- [**BREAKING**] Please prefix any breaking changes.

Here, #123 is the number of the original issue and/or your pull request. Please replace @user by your GitHub username.