.svg?style=flat&logo=dependabot&logoColor=white){kind=icon}
{{PROJECT DESC}}
Add a brief set of instructions on how to get quickly up and running for the most-common use cases. Delete this section if a quick-start concept doesn't apply.
Add a brief introduction as to how users, not developers, perform a normal installation of the project.
Add detail in this section regarding any dependencies or installation requirements that users, not developers, need before installing and using the project. This must focus on using the tool, not developing it. Delete this section if there are no production dependencies required for the project.
Provide detailed instructions on how to use this project, if applicable. Otherwise, delete this section.
If the project has configuration capabilities, provide them here in full detail. Otherwise, delete this section.
This project's Support Policy includes all details for users to get support for this project. As an open source project, support is generally limited to the surrounding community and isn't guaranteed. Please read this policy prior to opening an Issue or Discussion.
Parties interested in contributing to the project must read the Contributing Guidelines prior to doing so.
Finally, all individuals must adhere to the project's Code of Conduct, regardless of how they choose to engage with the community.
If you can answer common questions for your project, start this section. Delete the section, if not.
There are many ways to contribute to this project. If you have an idea, or have discovered a bug, please open an Issue. You can also start or join a Discussion to get your feet wet.
If you have interest in contributing to the project through design or development, please read the project's Contributing Guidelines.
Development of this project functions within a Development Container. This ensures that all development uses the same environment and has the same tools available within the project. This also reduces the development dependencies required to simply a container engine (such as Docker) and an IDE that supports Development Containers (such as Visual Studio Code).
For more information, see the Development Container README.md file.
The Project Maintainers recommend that Visual Studio Code and Docker are the underlying environment for the Development Container. Further, only *nix-based systems (for example, Linux, macOS) are formally supported for development with this project. Issues with Windows development environments isn't supported by Project Maintainers.
Use the following make command to configure Visual Studio Code to the minimum-required capabilities required to make
use of Development Containers:
make vscodeAn important part of the project's Software Development Lifecycle is continuous testing. The configuration of the project aims to make this as low effort as possible. The provided Development Container contains utilities to run all testing and linting pipelines exactly how the GitHub servers perform them to save time and effort when submitting Pull Requests.
Note: all commands should run inside of a Development Container.
To run a full suite of tests, including linting, use the provided test command:
make testThe project provides a number of utility functions to make your life easier during development. You can find the full list by running:
make helpReleases of this project follow Semantic Versioning standards in a MAJOR.MINOR.PATCH versioning
scheme of the following format:
MAJOR- used when the application undergoes major, incompatible changes with the last ReleaseMINOR- used when the Release adds capability in a backwards-compatible mannerPATCH- used when the Release patches existing capabilities, such as documentation, bug fixes, and minor features
GitHub hosts all Releases and manages all Release tags.
The LICENSE file contains the full text of this project's License.