Inferno Community
Welcome to the Inferno Community. The Inferno Framework is being developed under the Apache 2.0 license and the source is available in the Inferno Framework GitHub Organization. External participation and contributions to Inferno are encouraged and welcome. See below for how to engage with the Inferno team!
Inferno Team
The fastest way to reach the Inferno team is via the Inferno Chat on Zulip.
You can also e-mail the team.
Reporting Issues
We welcome feedback on the Test Kits that we have developed1, including but not limited to the following areas:
- Validation logic, such as potential bugs, lax checks, and unexpected failures.
- Requirements coverage, such as requirements that have been missed, tests that necessitate features that the IG does not require, or other issues with the interpretation of the IG’s requirements.
- User experience, such as confusing or missing information in the test UI.
Please report any issues on the given Test Kit’s Issues page under the Inferno Framework GitHub Organization.
Contributions
We welcome external contributions to our repositories. The information below explains expectations for contributors and the contribution process.
Code of Conduct
The Inferno Team has adopted a Code of Conduct that we expect all internal and external contributors to adhere to.
Branch Organization
The latest version of any Inferno repository is on the main
branch, and any Pull Request (PR) should be made against the main
branch.
Semantic Versioning
Inferno projects follow semantic versioning. We release patch versions for bugfixes, minor versions for new features, and major versions for any breaking changes. When we make breaking changes, we make note of it in the release and include what users have to do migrate changes.
For the ONC Certification (g)(10) Standardized API Test Kit, we release either a minor or major version monthly. Any issues that are reported for this Test Kit and are resolved with a given release are tagged with that release version. They are also tagged with “add constraint” if they cause systems that previously passed tests to now fail.
Proposing a Change
If you are interested in making a non-trivial change to one of our GitHub repositories, we recommend reporting an issue first. This allows us to make sure that the Inferno maintainers are on board with your approach before you put significant effort into this change. It is fine to submit a PR without a tracking issue for bug fixes, but we still recommend doing so in case we don’t accept that specific fix but want to keep track of the issue.
Submitting a Pull Request
When submitting a PR, please do the following:
- Confirm that all linters and tests pass
- Include any steps necessary to run and test the PR in the description
-
The Inferno team did not develop every Test Kit on the Inferno Framework GitHub. More information can be found on each Test Kit’s GitHub repository. ↩