Add contribution guidance (CONTRIBUTING.md) - #569
Open
dgarske wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Adds repository-level contribution guidance to wolfMQTT by introducing a new root CONTRIBUTING.md, aiming to document the contributor agreement requirement and general contribution workflow up front.
Changes:
- Add a new
CONTRIBUTING.mdcovering contribution paths, contributor agreement process, and CI expectations. - Document coding expectations (style, C90 constraints, return-code discipline) and security reporting guidance.
Suppressed comments (1)
CONTRIBUTING.md:49
- These PR submission steps hard-code
masteras the base branch. Since CI is set up for bothmasterandmainin this repo (e.g., .github/workflows/websocket-test.yml:5-8), it’s safer to refer to the repository’s default branch so the guidance remains accurate if the default ismain.
1. Fork the repository and create a topic branch off `master`.
2. Keep commits focused; one logical change per commit, with a clear message.
3. Open the pull request against `master`.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| @@ -0,0 +1,97 @@ | |||
| # Contributing | |||
|
|
|||
| Thank you for your interest in contributing to wolfSSL. This guide applies to all wolfSSL Inc. repositories (wolfSSL, wolfSSH, wolfTPM, wolfBoot, wolfMQTT, wolfCLU, wolfPKCS11, wolfHSM, wolfProvider, wolfSentry, and the rest). Please read the "Contributor Agreement" section below - it is the one requirement that surprises people, and we would rather you know about it up front. | |||
|
|
||
| ## Before You Start | ||
|
|
||
| - **Check `master` first.** The fix may already be in, or the surrounding code may have moved. Please base your work on the current `master`. |
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.