Skip to content
This repository has been archived by the owner on Oct 17, 2023. It is now read-only.

Latest commit

 

History

History
26 lines (14 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

26 lines (14 loc) · 1.48 KB

Contributing

Thank you for your interest in contributing to Magnesium Oxide! We are a community-driven project, and we welcome contributions from everyone following the Contributor Covenant.

Before you begin contributing, please take a read over the following sections to familiarize yourself with our contribution guidelines.

License

Magnesium Oxide is licensed under GNU GPLv3, submitting your code to our repository will result in your code being under the same license, and will be subject to the same terms of use.

Code Style

We highly encourage you to use the built-in formatting tools provided by Rust Analyzer in your IDE, alternatively you can run cargo fmt in your terminal to format your code before submitting.

Version Bumping

Please do not bump the version number manually, if you follow our commit guidelines the version number will be bumped automatically using the Semantic Versioning standard.

Commit Guidelines

  • Name your commits meaningful and concisely, not just "fix everything" commits.
  • Ensure that your commits are well-formed and follow the Conventional Commit Format.

Pull Request Guidelines

When submitting a pull request, please ensure you have a detailed description of the changes you are making, this is a critical part of the process to ensure that the pull request is accepted.