4.0 KiB
Contributing
Thank you for considering contributing to this project! This document provides guidelines and instructions for contributing.
Code of Conduct
By participating in this project, you agree to abide by our code of conduct:
- Be respectful and inclusive
- Be patient and welcoming
- Be considerate
- Be collaborative
- Be open-minded
How to Contribute
Reporting Bugs
If you find a bug, please report it by creating an issue on GitHub:
- Go to the Issues page
- Click "New Issue"
- Select "Bug Report"
- Fill out the template with as much detail as possible
- Submit the issue
Please include:
- A clear, descriptive title
- Steps to reproduce the bug
- Expected behavior
- Actual behavior
- Screenshots (if applicable)
- Your environment (WordPress version, PHP version, browser, etc.)
Suggesting Enhancements
If you have an idea for an enhancement:
- Go to the Issues page
- Click "New Issue"
- Select "Feature Request"
- Fill out the template with as much detail as possible
- Submit the issue
Please include:
- A clear, descriptive title
- A detailed description of the enhancement
- Why this enhancement would be useful
- Any relevant examples or mockups
Pull Requests
If you want to contribute code:
- Fork the repository
- Create a new branch for your feature or bugfix
- Make your changes
- Run tests to ensure your changes don't break anything
- Submit a pull request
Pull Request Process
- Fork the repository on GitHub or Gitea
- Clone your fork:
git clone https://github.com/YOUR-USERNAME/wp-plugin-starter-template-for-ai-coding.git - Create your feature branch:
git checkout -b feature/amazing-feature - Make your changes
- Commit your changes:
git commit -m 'Add some amazing feature' - Push to the branch:
git push origin feature/amazing-feature - Submit a pull request
Pull Request Guidelines
- Follow the coding standards (see Coding Standards)
- Write tests for your changes
- Update documentation as needed
- Keep pull requests focused on a single change
- Write a clear, descriptive title and description
- Reference any related issues
Development Environment
To set up your development environment:
- Clone the repository:
git clone https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding.git - Install dependencies:
composer install && npm install - Start the development environment:
npm run start
Testing
Before submitting a pull request, make sure to run the tests:
- PHP Unit Tests:
npm run test:php - End-to-End Tests:
npm run test:e2e - Coding Standards:
npm run lint:php
Documentation
If you're adding a new feature or changing existing functionality, please update the documentation:
- Update the README.md file if necessary
- Update the readme.txt file if necessary
- Update or create wiki pages as needed
- Update code comments
Community
Join our community to discuss the project:
Recognition
Contributors will be recognized in the following ways:
- Added to the contributors list in readme.txt
- Mentioned in release notes for significant contributions
- Thanked in the Changelog for specific contributions
License
By contributing to this project, you agree that your contributions will be licensed under the project's GPL-2.0+ License.
Questions?
If you have any questions about contributing, please open an issue or contact the maintainers.
Thank you for your contributions!