120 lines
4.1 KiB
Markdown
120 lines
4.1 KiB
Markdown
# Contributing
|
|
|
|
Thank you for your interest in contributing to the "Fix 'Plugin file does not exist' Notices" plugin! This page provides guidelines and instructions for contributing to the project.
|
|
|
|
## Ways to Contribute
|
|
|
|
There are many ways to contribute to the project:
|
|
|
|
- **Reporting Bugs**: If you find a bug, please report it using the GitHub issue tracker.
|
|
- **Suggesting Features**: Have an idea for a new feature? Share it using the GitHub issue tracker.
|
|
- **Writing Code**: Contribute code by fixing bugs or implementing new features.
|
|
- **Improving Documentation**: Help improve the documentation by fixing errors or adding new content.
|
|
- **Testing**: Test the plugin in different environments and report any issues.
|
|
- **Translating**: Help translate the plugin into different languages.
|
|
|
|
## Getting Started
|
|
|
|
### Setting Up the Development Environment
|
|
|
|
1. Fork the repository on GitHub.
|
|
2. Clone your fork to your local machine:
|
|
```
|
|
git clone https://github.com/your-username/wp-fix-plugin-does-not-exist-notices.git
|
|
```
|
|
3. Add the original repository as a remote:
|
|
```
|
|
git remote add upstream https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices.git
|
|
```
|
|
4. Create a new branch for your changes:
|
|
```
|
|
git checkout -b feature/your-feature-name
|
|
```
|
|
|
|
### Development Workflow
|
|
|
|
1. Make your changes to the code or documentation.
|
|
2. Test your changes thoroughly.
|
|
3. Commit your changes with a descriptive commit message:
|
|
```
|
|
git commit -m "Add feature: your feature description"
|
|
```
|
|
4. Push your changes to your fork:
|
|
```
|
|
git push origin feature/your-feature-name
|
|
```
|
|
5. Create a pull request from your fork to the original repository.
|
|
|
|
## Coding Standards
|
|
|
|
Please follow these coding standards when contributing code:
|
|
|
|
- Follow the [WordPress Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/).
|
|
- Use meaningful variable and function names.
|
|
- Add comments to explain complex code sections.
|
|
- Write unit tests for new features or bug fixes when possible.
|
|
- Ensure your code is compatible with PHP 7.0 and above.
|
|
- Test your code with WordPress 5.0 and above.
|
|
|
|
## Pull Request Guidelines
|
|
|
|
When submitting a pull request:
|
|
|
|
1. Provide a clear and descriptive title.
|
|
2. Include a detailed description of the changes.
|
|
3. Reference any related issues using the GitHub issue number (e.g., "Fixes #123").
|
|
4. Ensure your code passes all tests.
|
|
5. Update documentation if necessary.
|
|
6. Include screenshots or GIFs for UI changes if applicable.
|
|
|
|
## Reporting Bugs
|
|
|
|
When reporting bugs:
|
|
|
|
1. Use the GitHub issue tracker.
|
|
2. Provide a clear and descriptive title.
|
|
3. Describe the steps to reproduce the bug.
|
|
4. Include information about your environment:
|
|
- WordPress version
|
|
- PHP version
|
|
- Browser and version
|
|
- Operating system
|
|
5. Include screenshots or error messages if applicable.
|
|
6. Describe the expected behavior and the actual behavior.
|
|
|
|
## Suggesting Features
|
|
|
|
When suggesting features:
|
|
|
|
1. Use the GitHub issue tracker.
|
|
2. Provide a clear and descriptive title.
|
|
3. Describe the feature in detail.
|
|
4. Explain why the feature would be useful to users.
|
|
5. Include mockups or examples if applicable.
|
|
|
|
## Documentation Contributions
|
|
|
|
When contributing to documentation:
|
|
|
|
1. Follow the existing documentation style and format.
|
|
2. Use clear and concise language.
|
|
3. Include examples where appropriate.
|
|
4. Check for spelling and grammar errors.
|
|
5. Update the table of contents if necessary.
|
|
|
|
## Translation Contributions
|
|
|
|
To contribute translations:
|
|
|
|
1. Use the [WordPress translation platform](https://translate.wordpress.org/) if the plugin is hosted there.
|
|
2. Alternatively, you can create a pull request with translation files.
|
|
3. Ensure translations are accurate and maintain the meaning of the original text.
|
|
|
|
## Code of Conduct
|
|
|
|
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
|
|
|
|
## License
|
|
|
|
By contributing to this project, you agree that your contributions will be licensed under the project's [GPL-2.0+ license](LICENSE).
|