Skip to content

Latest commit

 

History

History
57 lines (42 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

57 lines (42 loc) · 2.71 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via Discussions.

General Guidelines

  • The Rust programming language is preferred for all code in this repository. A contribution that includes code in any other language will only be accepted under extraordinary circumstances.
  • Performance is a primary goal of this project. Please ensure your code is fast and safe.
  • High code coverage (95%+) is a requirement of this project. Make sure you add / update tests to cover your code.
  • Please use descriptive variable names. Code is the best documentation.
  • Please create tests in a separate file named _test.rs, rather than directly in the module file.
  • Keep it as simple as possible.

❗ Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull Request Process

  1. Update README.md with details of any changes pertaining to or related to the information already in the README.
  2. Do not change any versions in any Rust Cargo.toml files. Versions are automatically set as required as follow the SemVer standard.
  3. Once pull requests have been approved they will be automatically merged. If the source was a branch, rather than a private fork, the branch will be automatically deleted after the merge.

Release Versions

A release is created, by admins, via pushing a tag that matches the following regex: \d+.\d+.\d+, i.e. 1.1.1.

Code of Conduct

Our Pledge

Contributors and maintainers pledge to make project participation and community involvement harassment-free for everyone, regardless of various personal attributes.

Our Standards

Positive behaviors include using inclusive language, respecting differing opinions, accepting constructive criticism, and focusing on community welfare. Unacceptable behaviors include sexualized language, trolling, harassment, and other inappropriate conduct.

Our Responsibilities

Project maintainers are responsible for clarifying and enforcing acceptable behavior, including the right to remove or ban contributors for inappropriate actions.

Scope

This Code of Conduct applies in project and public spaces when representing the project or community. Project maintainers may define representation further.

Enforcement

Report unacceptable behavior to the project team, who will review and respond as necessary. Maintainers who don't enforce the Code of Conduct may face consequences as determined by project leadership.

This Code of Conduct is a ChatGPT generated summary of v1.4 of the Contributor Covenant.