Contributing

Contributing

We welcome contributions to the Private Comments plugin! Whether you're fixing a bug, suggesting a feature, or improving documentation, your help is appreciated. To ensure a smooth process for everyone, please follow these guidelines.

Reporting Bugs

If you find a bug, please help us by reporting it. Before opening a new issue, check the existing issues to see if it has already been reported.

When reporting a bug, please include:

• A clear and descriptive title.
• Steps to reproduce the issue.
• Expected behavior vs. actual behavior.
• Your WordPress version and PHP version.
• Any relevant error logs or screenshots.

Feature Requests

Have an idea to make this plugin better? Open an issue and label it as a "Feature Request." Describe the problem you are trying to solve and how the proposed feature would address it.

Development Workflow

If you want to contribute code, please follow this standard workflow:

1. Fork the Repository: Create your own copy of the project by clicking the "Fork" button at the top of the page.
2. Clone the Fork: Clone your fork to your local development environment.

   git clone https://github.com/your-username/wp-private-comments.git
   

3. Set Up a Local Environment: Use a local WordPress development tool (like LocalWP, DevKinsta, or Docker) to test your changes.
4. Create a Branch: Create a branch for your fix or feature.

   git checkout -b feature/your-feature-name
   

5. Commit Your Changes: Write clear, concise commit messages.

   git commit -m "Brief description of the change"
   

6. Push to GitHub: Push your changes to your fork.

   git push origin feature/your-feature-name
   

Pull Request Process

Once your changes are ready, submit a Pull Request (PR) from your branch to our main branch.

• Check Coding Standards: Ensure your code follows WordPress Coding Standards.
• Describe Your Changes: Explain what your PR does and link to any relevant issues (e.g., Closes #123).
• Test Your Code: Verify that your changes work as expected and do not break existing functionality.
• Stay Updated: If requested, make changes to your PR based on code review feedback.

Coding Standards

To maintain code quality and consistency, we follow the standard WordPress PHP Coding Standards. Please ensure your code is well-commented where necessary, particularly when interacting with WordPress hooks like comments_clauses or get_comments_number.