Add contribution guidance (CONTRIBUTING.md) - #569
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds repository-level contribution guidance to wolfTPM to set expectations for external contributors (especially the contributor agreement requirement) before work is done.
Changes:
- Introduces a new root-level
CONTRIBUTING.mdwith contribution paths (PR/email/issues) and contributor agreement workflow. - Documents CI visibility differences (public GitHub Actions vs internal Jenkins) and high-level coding expectations.
- Adds guidance on licensing context and reporting security issues.
Suppressed comments (1)
CONTRIBUTING.md:81
- This repo's LICENSE indicates wolfTPM is GPLv3 with a specific GPLv2 exception when combined with certain software; the current wording could imply GPLv3 is the only open-source option. Consider explicitly pointing readers to the repo's LICENSE/COPYING for any exceptions so the guidance stays accurate across repos.
Contributions are accepted under the license of the project you are contributing to - GPLv3 for most wolfSSL repositories. See that repository's `LICENSING`, `COPYING`, or `LICENSE` file for the specifics. The contributor agreement is what additionally allows wolfSSL Inc. to offer your contribution under a commercial license.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
dgarske
force-pushed
the
contributing_md
branch
from
August 12, 2026 17:32
7645a62 to
4263864
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Adds a
CONTRIBUTING.mdto the repository root. None of the wolfSSL repositories had one, so our contributor agreement requirement was only discovered after someone had already done the work. See wolfSSL/wolfssh#1146, where an outside contributor withdrew a PR over it and asked us to document the requirement up front.The same repo-agnostic file is being added to wolfSSL, wolfSSH, wolfMQTT, wolfTPM, wolfBoot, wolfPKCS11, wolfHSM, wolfProvider, wolfSentry and wolfCLU. It covers how to contribute, the contributor agreement and how to request one, our CI (GitHub Actions is public, Jenkins failures get pasted in by a maintainer), coding expectations, and where to report security issues. Please read the file itself rather than a summary here.
Testing
Documentation only - no code changes.