Merge branch 'main' into issue-101

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,54 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+### Describe the Bug
+A clear and concise description of what the bug is.
+
+### To Reproduce
+Steps to reproduce the behavior:
+1.
+2.
+3.
+
+### Expected Behavior
+A clear and concise description of what you expected to happen.
+
+### Environment
+Please provide the following details about your environment:
+
+- **Operating System**:
+- **Rust Version**: (e.g., 1.64.0)
+- **Project Version/Commit**: (e.g., 0.1.0 or specific commit hash)
+- **Dependencies**: (e.g., versions of dependencies, if relevant)
+
+### Configuration (if applicable)
+Provide any relevant configuration details, such as:
+
+### Configuration File (e.g., `config.toml`)
+```toml
+# Your configuration here
+```
+
+### Docker Setup (if applicable)
+Please include any Docker or container-related configuration that is relevant to the bug.
+
+### Topology (if applicable)
+```yaml
+# Your topology.yaml or equivalent file
+```
+
+### Logs and Debug Information
+If possible, provide logs or debug information that might help in diagnosing the issue.
+
+```text
+# Your log output here
+```
+
+### Additional Context
+Add any other context about the problem here, including potential workarounds or related issues.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+### Is your feature request related to a problem? Please describe.
+A clear and concise description of what the problem is.
+
+### Describe the solution you'd like
+A clear and concise description of what you want to happen.
+
+### Describe alternatives you've considered
+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.

.github/workflows/build_and_test.yaml

@@ -35,9 +35,9 @@ jobs:
     - uses: Swatinem/rust-cache@v2
       with:
         # rust-cache already handles all the sane defaults for caching rust builds.
-        # However because we are running seperate debug/release builds in parallel,
-        # we also need to add the runner and cargo_flags to the key so that a seperate cache is used.
-        # Otherwise only the last build to finish would get saved to the cache.
+        # However, because we are running separate debug/release builds in parallel,
+        # we also need to add the runner and cargo_flags to the key so that a separate cache is used.
+        # Otherwise, only the last build to finish would get saved to the cache.
         key: ${{ matrix.runner }} - ${{ matrix.cargo_flags }}
     - name: Install external deps for the prom-remote-api crate
       run: sudo apt-get install protobuf-compiler
@@ -48,10 +48,16 @@ jobs:
     - name: Ensure that all crates compile and have no warnings under every possible combination of features
       # some things to explicitly point out:
       # * clippy also reports rustc warnings and errors
-      # * clippy --all-targets causes clippy to run against tests and examples which it doesnt do by default.
-      run: cargo hack --feature-powerset clippy --all-targets --locked ${{ matrix.cargo_flags }} -- -D warnings
+      # * clippy --all-targets causes clippy to run against tests and examples which it doesn't do by default.
+      run: |
+        # Display all clippy lint failures as warnings
+        cargo hack --feature-powerset clippy --all-targets --locked ${{ matrix.cargo_flags }}
+        # Fail CI on the first crate to fail clippy lints
+        cargo hack --feature-powerset clippy --all-targets --locked ${{ matrix.cargo_flags }} -- -D warnings
     - name: Ensure that tests pass
-      run: cargo test ${{ matrix.cargo_flags }} --all-features --all-targets -- --nocapture
+      run: |
+        cargo test --doc ${{ matrix.cargo_flags }} --all-features -- --show-output --nocapture
+        cargo test ${{ matrix.cargo_flags }} --all-features --all-targets -- --nocapture
     - name: Ensure that tests did not create or modify any files that arent .gitignore'd
       run: |
         if [ -n "$(git status --porcelain)" ]; then

.gitignore

@@ -1,3 +1,5 @@
 /target
 *.flac
 .vscode/settings.json
+
+.idea

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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, caste, color, 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 email 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
+[INSERT CONTACT METHOD].
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,105 @@
+# Contributing to BRRO Compressor
+
+Thank you for considering contributing to the BRRO Compressor project! Whether it's a bug report, new feature, correction, or additional documentation, we greatly value and appreciate your efforts to improve this project.
+
+Below are the guidelines for contributing to the BRRO Compressor. Please take a moment to review them before submitting your contributions.
+
+## Table of Contents
+- [Code of Conduct](#code-of-conduct)
+- [How to Contribute](#how-to-contribute)
+    - [Reporting Issues](#reporting-issues)
+    - [Submitting Code Changes](#submitting-code-changes)
+    - [Coding Standards](#coding-standards)
+- [Running Tests](#running-tests)
+- [Documentation](#documentation)
+
+## Code of Conduct
+
+This project adheres to a code of conduct that is based on respect, collaboration, and inclusivity. By participating in this project, you agree to uphold these values. Please report any issues or behavior that violates these guidelines to the project maintainers.
+
+## How to Contribute
+
+### Reporting Issues
+
+If you encounter a bug, performance issue, or have a suggestion for an enhancement, please open an issue in our [GitHub repository](https://github.com/instaclustr/atsc/issues). Make sure to provide as much detail as possible to help us understand the problem or suggestion. **But check for existing issues first!**
+
+When reporting an issue, please include:
+- A clear and descriptive title.
+- A detailed description of the issue or suggestion.
+- Steps to reproduce the issue, if applicable.
+- Any relevant logs, screenshots, or output that might help us diagnose the problem.
+
+### Submitting Code Changes
+
+We accept contributions via Pull Requests (PRs). Before submitting a PR, please follow these steps:
+
+1. **Fork the repository** to your GitHub account.
+2. **Create a new branch** for your changes.
+   - If you're creating a bugfix branch, name it XXX-something, where XXX is the issue number.
+   - If you're working on a new feature, first create an issue to announce your intentions, then name the branch XXX-something, where XXX is the issue number.
+3. **Make your changes** in this branch.
+4. **Test your changes** to ensure that they do not break existing functionality.
+5. **Commit your changes** with a meaningful commit message.
+6. **Push your changes** to your forked repository.
+7. **Create a Pull Request** to the main branch of the original repository.
+
+#### How to Create a Pull Request (PR)
+
+1. Go to the [GitHub repository](https://github.com/instaclustr/atsc).
+2. Click on the "Pull Requests" tab.
+3. Press the **"New pull request"** button.
+4. Select the **base repository** and the branch where you want to merge your changes (`main`).
+5. Compare this with the branch containing your changes (your forked repository and branch).
+6. Provide a **descriptive title** and **clear description** of the changes in the PR.
+7. Link any relevant issues by adding `Closes #IssueNumber` to the description.
+8. Submit your pull request.
+
+#### Guidelines for Pull Requests
+
+- Provide a clear description of your changes and the problem they solve.
+- Reference any relevant issues or discussions in your PR description.
+- When you make a PR for small change (such as fixing a typo, grammar fix), please squash your commits so that we can maintain a cleaner git history.
+- Include any necessary documentation updates as part of your PR.
+- Ensure that your code adheres to the project's coding standards (see below).
+- Code review comments might be added to your pull request. Please discuss them, implement the suggested changes, and push additional commits to your feature branch. Make sure to leave a comment after pushing. 
+The new commits will appear in the pull request automatically, but the reviewers won't be notified unless you comment.
+- If your PR is a work-in-progress (WIP), please indicate this in the title by prefixing it with `[WIP]`.
+
+If your pull request isn't accepted right away, don't get discouraged! If there are issues with the implementation, you'll likely receive feedback on what can be improved.
+
+### Coding Standards
+
+To maintain consistency and quality across the codebase, please adhere to the following coding standards:
+
+- Follow the naming conventions and coding style already present in the codebase.
+- Keep functions and methods small and focused.
+- Write descriptive comments where necessary, especially in complex sections of code.
+- Ensure your code is linted and formatted according to the project's style guides.
+
+## Running Tests
+
+All code changes should be covered by tests. To run the test suite, use the following command: `cargo test`
+
+## Documentation
+
+Good documentation is crucial for the usability and maintainability of the project. If you are adding a new feature or modifying existing behavior, ensure that you update the relevant documentation files.
+
+- See `docs/README.md` for more information on building the docs and how docs get released.
+- Ensure that your changes are reflected in the usage instructions or other relevant sections.
+
+## Roadmap
+
+We have a long-term vision for the BRRO Compressor project, and we encourage contributors to get involved with features that are planned for future releases. Below is a brief overview of our current roadmap:
+
+- Implement streaming compression/decompression.
+- Expand frames to allow new data to be appended to existing frames.
+
+Feel free to contribute to these ongoing efforts or propose your own enhancements!
+
+## Feedback and Suggestions
+
+We value your feedback and suggestions! If you have any ideas on how to improve the BRRO Compressor, please don't hesitate to share them. You can do so by:
+
+- Opening a new issue labeled as a `suggestion` in our [GitHub repository](https://github.com/instaclustr/atsc).
+
+Your input helps us shape the future of the project, and we appreciate any suggestions or feedback you can provide.