diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..ef243b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,29 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +## Describe the bug + +A clear and concise description of what the bug is. + +A clear and concise description of what you expected to happen. + +## Minimal Reproducible Examples (MRE) + +Please try to provide information which will help us to fix the issue faster. MREs with few dependencies are especially lovely <3. + +If applicable, add logs/screenshots to help explain your problem. + +**Environment (please complete the following information):** + - Platform: [e.g.`uname -a`] + - Rust [e.g.`rustic -vV`] + - Cargo [e.g.`cargo -vV`] + +## Additional context + +Add any other context about the problem here. For example, environment variables like `CARGO`, `RUSTUP_HOME` or `CARGO_HOME`. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..68f8467 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,28 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +## Problem + +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +Include Issue links if they exist. + +Minimal Reproducible Examples (MRE) with few dependencies are useful. + +## Solution + +A clear and concise description of what you want to happen. + +## Alternatives + +A clear and concise description of any alternative solutions or features you've considered. + +## Additional context + +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/spec_bug_report.md b/.github/ISSUE_TEMPLATE/spec_bug_report.md new file mode 100644 index 0000000..0b6f87f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/spec_bug_report.md @@ -0,0 +1,27 @@ +--- +name: Specification Non-conformance report +about: Report an error in our implementation +title: '' +labels: specification +assignees: '' + +--- + +## Describe the bug + +A clear and concise description of what the bug is. + +Please include references to the relevant specification; for example: + +> RFC 2616, section 4.3.2: +> +> > The HEAD method is identical to GET except that the server MUST NOT +> > send a message body in the response + +## Minimal Reproducible Examples (MRE) + +Please try to provide information which will help us to fix the issue faster. MREs with few dependencies are especially lovely <3. + +## Additional context + +Add any other context about the problem here. For example, any other specifications that provide additional information, or other implementations that show common behavior. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..9f329cd --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +johnstonskj@gmail.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..204cfcb --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,63 @@ +# How to contribute + +I'm really glad you're reading this, because we need volunteer developers to help this project continue to grow and improve. + +1. file [bugs](../../issues/new?assignees=&labels=bug&template=bug_report.md) and + [enhancement requests](../../issues/new?assignees=&labels=enhancement&template=feature_request.md) +2. review the project documentation know if you find are issues, or missing content, there +3. Fix or Add something and send us a pull request; you may like to pick up one of the issues marked [help wanted](../../labels/help%20wanted) or [good first issue](../../labels/good%20first%20issue) as an introduction. Alternatively, [documentation](../../labels/documentation) issues can be a great way to understand the project and help improve the developer experience. + +## Submitting changes + + +We love pull requests from everyone. By participating in this project, you agree to abide by our [code of conduct](./CODE_OF_CONDUCT.md), and [License](./LICENSE). + +Fork, then clone the repo: + + git clone git@github.com:johnstonskj/{{repository-name}}.git + +Ensure you have a good Rust install, usually managed by [Rustup](https://rustup.rs/). +You can ensure the latest tools with the following: + + rustup update + +Make sure the tests pass: + + cargo test --package {{package-name}} --no-fail-fast --all-features -- --exact + +Make your change. Add tests, and documentation, for your change. Ensure not only that tests pass, but the following all run successfully. + + cargo doc --all-features --no-deps + cargo fmt + cargo clippy + +If you made changes to the book source, ensure the following runs successfully + + mdbook build + +If you have made any changes to `Cargo.toml`, also check: + + cargo outdated + cargo audit + +Push to your fork and [submit a pull request](../../compare/) using our [template](./pull_request_template.md). + +At this point you're waiting on us. We like to at least comment on pull requests +within three business days (and, typically, one business day). We may suggest +some changes or improvements or alternatives. + +Some things that will increase the chance that your pull request is accepted: + +* Write unit tests. +* Write API documentation. +* Write a [good commit message](https://cbea.ms/git-commit/https://cbea.ms/git-commit/). + +## Coding conventions + +The primary tool for coding conventions is rustfmt, and specifically `cargo fmt` is a part of the build process and will cause Actions to fail. + +DO NOT create or update any existing `rustfmt.toml` file to change the default formatting rules. + +DO NOT alter any `warn` or `deny` library attributes. + +DO NOT add any `feature` attributes that would prohibit building on the stable channel. In some cases new crate-level features can be used to introduce an unstable feature dependency but these MUST be clearly documented and optional. diff --git a/pull_request_template.md b/pull_request_template.md new file mode 100644 index 0000000..be6302c --- /dev/null +++ b/pull_request_template.md @@ -0,0 +1,38 @@ +# Description + +Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change. + +Fixes # (issue) + +## Type of change + +Please delete options that are not relevant. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + +# How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration + +- [ ] Test A +- [ ] Test B + +**Environment (please complete the following information):** + - Platform: [e.g.`uname -a`] + - Rust [e.g.`rustic -vV`] + - Cargo [e.g.`cargo -vV`] + +# Checklist: + +- [ ] My code follows the style guidelines of this project (e.g. run `cargo fmt`) +- [ ] I have performed a self-review of my code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] My changes DO NOT require unstable features without prior agreement +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes +- [ ] Any dependent changes have been merged and published in downstream modules