Skip to content

Docs Contributing Guide#33

Merged
jasperf merged 2 commits into
mainfrom
docs-contributing-guide
May 30, 2026
Merged

Docs Contributing Guide#33
jasperf merged 2 commits into
mainfrom
docs-contributing-guide

Conversation

@jasperf

@jasperf jasperf commented May 30, 2026

Copy link
Copy Markdown
Contributor

This is a documentation-focused release that extracts developer-facing material out of the README into a dedicated CONTRIBUTING.md and bumps the plugin to version 2.1.2. The new CONTRIBUTING.md (51 lines) consolidates the build-from-source instructions, development environment setup, dependency list, and change-submission guidelines that were previously scattered through the README, leaving the README focused on user-facing installation and usage. The README's "Build from Source", "Development", and "Dependencies" sections were removed and replaced with a concise "Contributing" pointer, which also required renumbering the Composer install method from Method 4 to Method 3. Distribution metadata (.distignore and .gitattributes) was updated to exclude the new file from the packaged plugin, and the version bump was propagated across all canonical version locations. There are no functional or behavioral changes to the plugin itself.

Documentation and Developer Guidance:

  • Added CONTRIBUTING.md (51 lines) at the repository root covering build-from-source, development setup, dependencies, and how to submit changes, centralizing previously fragmented developer documentation.
  • Trimmed the "Build from Source", "Development", and "Dependencies" sections from README.md and replaced them with a short "Contributing" section pointing to CONTRIBUTING.md and docs/dev.md, keeping the README focused on end users.
  • Renumbered the Composer installation method from Method 4 to Method 3 to reflect the removal of the standalone build-from-source method.

Version Bump (2.1.1 to 2.1.2):

  • Updated the canonical version in warder-cookie-consent.php (Version: header and WARDER_VERSION constant), package.json, and readme.txt (Stable tag:).
  • Added 2.1.2 entries to CHANGELOG.md, plus == Changelog == and == Upgrade Notice == sections in readme.txt, documenting this as a documentation-only release with no functional changes.

Distribution Packaging:

  • Added CONTRIBUTING.md to .distignore and .gitattributes (export-ignore) so the developer guide is excluded from the distributed plugin ZIP and the WordPress.org package, consistent with the existing handling of README.md and CLAUDE.md.

Files Changed:

jasperf added 2 commits May 30, 2026 11:38
Move the Build from Source, Development, and Dependencies sections out of
the README into a new root-level CONTRIBUTING.md, leaving a short
Contributing pointer in the README and renumbering the Composer install
method. Exclude CONTRIBUTING.md from the distributed plugin (.distignore)
and Composer dists (.gitattributes), matching the other dev docs.
Documentation-only release. Update the Version header and WARDER_VERSION
constant, package.json version, readme.txt Stable tag, and add Changelog
and Upgrade Notice entries across CHANGELOG.md and readme.txt.
@jasperf
jasperf merged commit 834f2dd into main May 30, 2026
2 checks passed
@jasperf
jasperf deleted the docs-contributing-guide branch May 30, 2026 04:42
Sign up for free to 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.

1 participant