mirror of
https://github.com/oblakstudio/wp-plugin-installer.git
synced 2025-12-08 14:16:29 +08:00
28 lines
1.4 KiB
Markdown
28 lines
1.4 KiB
Markdown
|
# Contribution Guidelines
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
## Reporting bugs / Feature requests
|
||
|
|
|
||
|
|
If you think you have found a bug, please [open an issue](https://github.com/oblakstudio/wp-plugin-installer/issues/new) and provide as much information as possible.
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
If you would like to contribute code to this project you can do so through GitHub by forking the repository and sending a pull request.
|
||
|
|
|
||
|
|
## Coding standards
|
||
|
|
|
||
|
|
This project follows the [WordPress Coding Standards](https://make.wordpress.org/core/handbook/best-practices/coding-standards/). Pull requests should follow these standards as well, and are run against PHPCS to ensure this.
|
||
|
|
|
||
|
|
## Unit tests
|
||
|
|
|
||
|
|
This project wants to use [PHPUnit](https://phpunit.de/) for unit testing - but no tests are written so far. If you would like to contribute tests, please do so.
|
||
|
|
|
||
|
|
## Commit messages
|
||
|
|
|
||
|
|
This project follows the [AngularJS commit message conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit) for commit messages. This gives us more readable history, and easy follow of changes across versions. It also enables automatic versioning and changelog generation.
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
This project uses [Docsify](https://docsify.js.org/) for documentation. If you would like to contribute to the documentation, please do so.
|
