Add notes about keeping README.md and readme.txt in sync
This commit is contained in:
17
README.md
17
README.md
@ -109,9 +109,16 @@ We welcome contributions to WP Multisite WaaS! Here's how you can contribute eff
|
|||||||
- Generate translation POT files
|
- Generate translation POT files
|
||||||
- Minify CSS and JS assets
|
- Minify CSS and JS assets
|
||||||
- Process and optimize other assets
|
- Process and optimize other assets
|
||||||
6. Commit your changes (`git commit -m 'Add some amazing feature'`)
|
6. **Important:** Update both README.md and readme.txt files when making changes that affect:
|
||||||
7. Push to the branch (`git push origin feature/amazing-feature`)
|
- Version numbers
|
||||||
8. Open a Pull Request
|
- Required WordPress/PHP versions
|
||||||
|
- Feature additions or changes
|
||||||
|
- Installation instructions
|
||||||
|
- Documentation
|
||||||
|
- Changelog entries
|
||||||
|
7. Commit your changes (`git commit -m 'Add some amazing feature'`)
|
||||||
|
8. Push to the branch (`git push origin feature/amazing-feature`)
|
||||||
|
9. Open a Pull Request
|
||||||
|
|
||||||
### Pull Request Guidelines
|
### Pull Request Guidelines
|
||||||
|
|
||||||
@ -123,6 +130,7 @@ When submitting pull requests, please:
|
|||||||
4. Include screenshots or GIFs for UI changes if applicable
|
4. Include screenshots or GIFs for UI changes if applicable
|
||||||
5. Make sure all tests pass (if available)
|
5. Make sure all tests pass (if available)
|
||||||
6. Update documentation as needed
|
6. Update documentation as needed
|
||||||
|
7. Verify that both README.md and readme.txt are updated and synchronized
|
||||||
|
|
||||||
### Release Process
|
### Release Process
|
||||||
|
|
||||||
@ -145,7 +153,8 @@ This will automatically:
|
|||||||
When preparing for a release:
|
When preparing for a release:
|
||||||
1. Update the version number in the main plugin file and readme.txt
|
1. Update the version number in the main plugin file and readme.txt
|
||||||
2. Update the changelog in readme.txt
|
2. Update the changelog in readme.txt
|
||||||
3. Create and push the appropriate version tag
|
3. Ensure README.md and readme.txt are synchronized with the latest information
|
||||||
|
4. Create and push the appropriate version tag
|
||||||
|
|
||||||
## 🆘 Support
|
## 🆘 Support
|
||||||
|
|
||||||
|
17
readme.txt
17
readme.txt
@ -47,11 +47,18 @@ We welcome contributions to WP Multisite WaaS! To contribute effectively:
|
|||||||
* Generate translation POT files
|
* Generate translation POT files
|
||||||
* Minify CSS and JS assets
|
* Minify CSS and JS assets
|
||||||
* Process and optimize other 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:**
|
**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:**
|
**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*.*.*).
|
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).
|
For more detailed contribution guidelines, see the [GitHub repository](https://github.com/superdav42/wp-multisite-waas).
|
||||||
|
|
||||||
== Installation ==
|
== Installation ==
|
||||||
|
Reference in New Issue
Block a user