docs: create contributing doc #369
Open
+400
−116
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
moves development and contributing documentation into a standard CONTRIBUTING.md and update current docs to reference it Also includes fixes for incorrect test commands and dir structure Signed-off-by: Alex Bozarth <ajbozart@us.ibm.com>
Contributor
|
The PR description has been updated. Please fill out the template for your PR to be reviewed. |
Merge ProtectionsYour pull request matches the following merge protections and will not be merged until they are valid. 🟢 Enforce conventional commitWonderful, this rule succeeded.Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
|
Contributor
Author
|
Note that the ruff and mypy commands documented currently fail. I've opened #370 to address it in a follow up. |
psschwei
reviewed
Jan 27, 2026
This was referenced Jan 28, 2026
Signed-off-by: Alex Bozarth <ajbozart@us.ibm.com>
Contributor
Author
|
@psschwei I've pushed a commit addressing all your inline comments if you'd like to take a look |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Misc PR
Type of PR
Description
Moves development and contributing documentation into a standard
CONTRIBUTING.mddoc and updates current docs to reference it.Also includes fixes for incorrect test commands and dir structure found while creating the doc
Testing