Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 3.08 KB

CONTRIBUTING.md

File metadata and controls

60 lines (40 loc) · 3.08 KB
Raw

Contributing to PageFlash

Thank you for considering contributing to PageFlash! We welcome contributions from the community to help make our plugin even better. This document provides guidelines for how you can contribute to PageFlash.

How Can You Contribute?

There are several ways to contribute to PageFlash:

  1. Reporting Issues: If you encounter a bug or have a feature request, please open an issue. Make sure to provide as much detail as possible, including steps to reproduce the issue and the expected outcome.

  2. Fixing Bugs: If you're a developer and would like to fix a bug, feel free to fork the repository and submit a pull request. Please ensure your code follows our coding standards.

  3. Improving Documentation: If you find gaps or errors in our documentation, you can contribute by submitting documentation updates or improvements.

  4. Enhancing Features: If you have ideas for new features or enhancements, please open an issue to discuss your proposal. We encourage the community to provide feedback on feature proposals.

Getting Started

If you're ready to contribute, follow these steps to get started:

  1. Fork the Repository: Click the "Fork" button on the top right of the PageFlash repository to create your copy of the repository.

  2. Clone Your Fork: Clone your fork to your local machine using Git:

   git clone https://github.com/yourusername/pageflash.git

After:

1 Create a New Branch: Create a new branch for your work with a descriptive name:

    git checkout -b feature/your-feature

2 Make Changes: Make the necessary code changes or documentation updates.

3 Test Your Changes: Ensure your changes work as expected and do not introduce new issues.

4 Commit Your Changes: Commit your changes with a descriptive commit message:

    git commit -m "Add new feature: your feature description"

5 Push Your Changes: Push your changes to your fork:

    git push origin feature/your-feature

6 Open a Pull Request: Go to the PageFlash repository on GitHub and open a pull request from your fork to the main repository. Provide details about the changes you made and reference any related issues

Code Style and Standards

To maintain code quality and consistency, please adhere to the following guidelines:

  • Use clear and meaningful variable and function names.
  • Follow WordPress coding standards.
  • Include comments to explain code functionality when necessary.

Licensing

By contributing to PageFlash, you agree that your contributions will be licensed under the GNU General Public License (GPL). You retain the copyright to your contributions.

Thank you for considering contributing to PageFlash. Your contributions help improve the plugin and provide a better experience for our users.

Happy contributing! 🚀