All contributions are valued and welcomed, whether they come in the form of code, documentation, ideas or discussion. While we have not applied a formal Code of Conduct to this, or related, repositories, we require that all contributors conduct themselves in a professional and respectful manner.
The easiest way to contribute to rhel-sriov-test is through Issues. This could be by making a suggestion, reporting a bug, or helping another user.
To make a suggestion open an Issue in the GitHub repository describing what feature/change you think is needed, why, and if possible give an example.
❗ Red Hat does not provide commercial support for the content of this repo. Any assistance is purely on a best-effort basis, as resources permit.
If you encounter a bug then carefully examine the output. If you choose to open an issue then please include as much information about the problem as possible, as this gives the best chance someone can help. We suggest:
- A description of your environment
- A copy of your report and standard output
This may include data you do not wish to share publicly. In this case a more private forum is suggested.
The required workflow for making a contribution is Fork-and-Pull. This is well documented elsewhere but to summarize:
- Create a fork of this repository.
- Make and test the change on your fork.
- Submit a Pull Request asking for the change to be merged into the main repository.
How to create and update a fork is outside the scope of this document but there are plenty of in-depth instructions explaining how to go about it.
All contributions must have as much test coverage as possible and include relevant additions and changes to both documentation and tooling. Once a change is implemented, tested, documented, and passing all checks then submit a Pull Request for it to be reviewed.
At least two maintainers must "Accept" a Pull Request prior to merging a Pull Request. No Self Review is allowed. The maintainers of rhel-sriov-test are:
- Jianzhu Zhang (jianzzha)
- Daniel Kostecki (dkosteck)
- Andrew Kiselev (akiselev1)
All contributors are strongly encouraged to review Pull Requests. Everyone is responsible for the quality of what is produced, and review is also an excellent opportunity to learn.
A good commit does a single thing, does it completely, concisely, and describes why.
The commit message should explain both what is being changed and, in the case of anything non-obvious, why that change was made. Commit messages are something that has been extensively written about so need not be discussed in more detail here, but contributors should follow these seven rules and keep individual commits focussed.
A good Pull Request is the same; it also does a single thing, does it completely, and describes why. The difference is that a Pull Request may contain one or more commits that together prepare for and deliver a feature.
Instructions on how to restructure commits to create a clear and understandable set of changes is outside the scope of this document, but it's a useful skill and there are many guides and approaches for it.
- Favor readability over brevity in both naming and structure
- Document the why with comments, and the what with clear code
- When in doubt, follow the PEP 8 style guide
All SR-IOV tests must be identified via either a tag or a commit hash, representing a globally unique identifier for said test. This provides traceability and an unambiguous way to
reference specific tests. For this reason, the "common name" a test receives is not considered its formal reference, and may
remain even if a test changes. Semantic versioning of tags should be observed to create relevant links to unique tests. For more information, see the root level README.md, Releases, and Semantic Versioning.
As this identifier is used to identify a specific, unique test definition, a change to the tag is required whenever the functionality/content of a test case changes, inclusive of bug fixes. Practically, this means that when changes are merged to main the tag and release should change. Maintaining proper versioning should be a main consideration of the repository maintainers after accepting a Pull Request and merging to main.
All SR-IOV and common tests should be validated to work and, in cases where changes affect common code, that changes do not break existing tests or common code. To this end there are GitHub Actions running to validate formatting by way of a linter, a series of mock tests checking the common code, as well as an option to run tests on a lab machine. The linter and mocks run automatically on Pull Requests.
The optional "real" testing can be run by applying the "e2e-test" label to the Pull Request. This will start an action which queues either an end-to-end test (where common code is affected) or runs the specific test modified (when no common code is affected). Because these tests take both time and resources, they should only be started after the PR is ready to merge as a final check of functionality, and this label should only be utilized by repository maintainers. After the test run, the Action will remove the "e2e-test" label.
"e2e-test" label triggers end-to-end test execution using 810-series NIC ports. Alternatively, "e2e-test-710" label can be used for end-to-end test execution on 710-series NICs.