Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (47 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

63 lines (47 loc) · 1.73 KB

Contributing to Under Construction Plugin

Thank you for your interest in contributing to the Under Construction plugin!

How to Contribute

Reporting Bugs

If you find a bug, please create an issue on GitHub with:

  • A clear title and description
  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • WordPress version
  • PHP version
  • Any relevant screenshots or error messages

Suggesting Enhancements

We welcome feature suggestions! Please create an issue with:

  • A clear title and description
  • Explanation of why this feature would be useful
  • Any examples or mockups if applicable

Code Contributions

  1. Fork the repository
  2. Create a new branch for your feature or bugfix
  3. Make your changes
  4. Test your changes thoroughly
  5. Ensure your code follows WordPress coding standards
  6. Submit a pull request

Coding Standards

  • Follow WordPress Coding Standards
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Ensure all user inputs are properly escaped
  • Include security checks (nonces, capability checks, etc.)

Testing

Before submitting a pull request, please:

  • Test on a fresh WordPress installation
  • Test with different themes
  • Test both HTML and Page modes
  • Verify administrator bypass works correctly
  • Check for PHP errors and warnings
  • Test on different browsers and devices

Development Setup

  1. Clone the repository
  2. Install WordPress locally
  3. Create a symbolic link from the plugin directory to your WordPress plugins folder
  4. Activate the plugin
  5. Make your changes
  6. Test thoroughly

Questions?

Feel free to create an issue if you have any questions about contributing.