wpallstars/wp-multisite-waas
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add notes about keeping README.md and readme.txt in sync

Browse Source
This commit is contained in:
Marcus Quinn
2025-04-07 20:17:56 +01:00
parent 0b8a9ccc85
commit 4af2a67726
2 changed files with 28 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
readme.txt
View File

@ -47,11 +47,18 @@ We welcome contributions to WP Multisite WaaS! To contribute effectively:
* Generate translation POT files
* Minify CSS and JS assets
* Process and optimize other assets
6. Open a Pull Request with your changes
6. **Important:** Update both README.md and readme.txt files when making changes that affect:
* Version numbers
* Required WordPress/PHP versions
* Feature additions or changes
* Installation instructions
* Documentation
* Changelog entries
7. Open a Pull Request with your changes
**Pull Request Guidelines:**
Please include a clear description of your changes and their purpose, reference any related issues, and ensure your code follows existing style conventions.
Please include a clear description of your changes and their purpose, reference any related issues, and ensure your code follows existing style conventions. Always verify that both README.md and readme.txt are updated and synchronized before submitting your PR.
**Release Process:**
@ -62,6 +69,12 @@ To trigger a new release build, push a tag following the semantic versioning for
The tag must begin with "v" followed by the version number (v*.*.*).
When preparing for a release:
1. Update the version number in the main plugin file and readme.txt
2. Update the changelog in readme.txt
3. Ensure README.md and readme.txt are synchronized with the latest information
4. Create and push the appropriate version tag
For more detailed contribution guidelines, see the [GitHub repository](https://github.com/superdav42/wp-multisite-waas).
== Installation ==