Uh oh!
There was an error while loading. Please reload this page.
Add contribution guidance (CONTRIBUTING.md) - #86
Conversation
There was a problem hiding this comment.
Pull request overview
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Adds a repository-root CONTRIBUTING.md to document contribution paths and set expectations up front—especially the required contributor agreement—based on prior contributor friction (wolfSSL/wolfssh#1146).
Changes:
- Introduces contribution workflow guidance (PRs, emailed patches, issues)
- Documents required contributor agreement process and alternatives if it can’t be signed
- Describes CI visibility (GitHub Actions vs internal Jenkins), coding expectations, and security reporting channel
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
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.