Contributing to WP Bones

This document explains how to contribute to the WP Bones framework. It encourages users to become sponsors to support development and provides instructions for submitting bug reports and documentation contributions. It highlights the importance of detailed bug reports, including steps to reproduce issues, expected behavior, and actual outcomes. The document also emphasizes the value of contributing to documentation to improve clarity, accuracy, and accessibility for other users. Links are provided for submitting issues and becoming a sponsor.

👏

Thank you for considering contributing to the WP Bones framework!

How to Contribute

Contributing to the WP Bones framework is a great way to help improve the project and support the WordPress community. Here are some ways you can contribute:

Fork the WP Bones repository

Go to the WP Bones GitHub repository .
Click the “Fork” button in the top right corner to create a copy of the repository in your own GitHub account.

Clone your forked repository to your local machine in your desired location. This folder will serve as the destination for the WP Bones framework. You may also create a new branch for your changes.


git clone https://github.com/<your-username>/wpbones.git <forked-repo>
cd <forked-repo>
git checkout -b my-feature-branch

Clone a WP Kirk repository

Due to the nature of the WP Bones framework, and the WordPress ecosystem, it is recommended to clone any WP Kirk boilerplate to get started. This will provide you with a solid foundation for your development work. We recommend using the WP Kirk Boilerplate as a starting point.

Follow the instructions in the Installation and remember DO NOT RENAME AND CHANGE THE NAMESPACE of the plugin folder.


git clone -b main https://github.com/wpbones/WPKirk-Boilerplate.git <your-plugin-folder>

You can now use this plugin to edit the WP Bones framework in the vendor/wpbones/wpbones folder. You may also modify the bones command in the root of the plugin.

Make your changes

You can now modify the WP Bones framework. Ensure you follow best practices and coding standards when making changes.

Copy/sync your changes

You can copy or sync your changes to the original forked repository. Begin from the root of your boilerplate plugin folder.


cd <your-plugin-folder>


rsync -aE --delete --exclude=".git/" "vendor/wpbones/wpbones/" "<forked-repo>/WPBones/"

💡

Certainly, you can use any tool you prefer for syncing files, like rsync, cp, or another file synchronization tool.

For instance, Kaleidoscope is excellent for comparing and syncing files.
If you are using Raycast , you can install the Sync Folders extension to sync files easily.

😎

We already planned to add a bones sync command to the WP Bones framework, which will automate this process in the future.

If you have modified the bones command, you need to copy those changes too.


cp bones <forked-repo>/WPBones/src/Console/bin/bones

Commit your changes

Now you can commit your changes to the forked repository. Make sure to write clear and descriptive commit messages.


cd <forked-repo>
git add .
git commit -m "Describe your changes here"

Push your changes


git push origin my-feature-branch

Create a pull request

Go to your forked repository on GitHub.
Click the “Pull requests” tab.
Click the “New pull request” button.
Select the branch you created and compare it with the main branch of the WP Bones repository.
Add a title and description for your pull request, explaining the changes you made and why they are important.
Click the “Create pull request” button.

Framework Bug Reports

When encountering issues with software or applications, submitting a detailed bug report can significantly help developers in understanding and resolving the problem efficiently. A well-written bug report should include clear steps to reproduce the issue, the expected behavior, and the actual outcome.

Furthermore, providing information such as system specifications, error messages, and screenshots can aid in pinpointing the root cause of the bug. By utilizing platforms like GitHub, users can create issue tickets with relevant details, facilitating effective communication between users and developers. Remember, a comprehensive bug report not only assists in bug resolution but also improves the overall quality of the software.

🐛 Click here to submit a Framework issue

Documentation Contributions

Documentation is an essential component of software development, providing users with valuable information on how to use and understand the software. By contributing to documentation, users can help improve the clarity, accuracy, and accessibility of information, making it easier for others to learn and utilize the software effectively.

🐛 Click here to fork the WP Bones docs

🐛 Click here to submit a Documentation issue

Core Development Discussion

Discussion regarding bugs, new features, ideas 💡, and implementation of existing features takes place in the issue GitHub channel. If you like, you may connect to the Discord channel as well.

Coding style

WP Bones follows the PSR-2 coding standard and the PSR-4 autoloading standard.