Skip to content

Add contribution guidance (CONTRIBUTING.md) - #86

Merged
douzzer merged 1 commit into
wolfSSL:masterfrom
dgarske:contributing_md
Aug 21, 2026
Merged

Add contribution guidance (CONTRIBUTING.md)#86
douzzer merged 1 commit into
wolfSSL:masterfrom
dgarske:contributing_md

Conversation

@dgarske

Copy link
Copy Markdown
Member

Description

Adds a CONTRIBUTING.md to 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.

CopilotAI lite review requested due to automatic review settings August 11, 2026 23:00

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment threadCONTRIBUTING.md Outdated
Comment threadCONTRIBUTING.md Outdated
Comment threadCONTRIBUTING.md Outdated
Comment threadCONTRIBUTING.md Outdated
@douzzer
douzzer merged commit b2391f5 into wolfSSL:masterAug 21, 2026
2 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@dgarske@douzzer@wolfSSL-Bot