raspap-webgui-mirror/CONTRIBUTING.md

19 lines
1.5 KiB
Markdown
Raw Normal View History

2017-10-23 21:52:43 +00:00
## How to contribute
2023-11-02 08:48:13 +00:00
Everyone is invited and welcome to contribute to RaspAP. There's a lot to do — if you're not a developer perhaps you'd like to help with the documentation on [docs.raspap.com](https://docs.raspap.com)? If you're a devloper, the process of contributing code is straightforward.
2017-10-23 21:52:43 +00:00
2020-02-12 21:28:29 +00:00
1. Fork the project in your account and create a new branch: `your-great-feature`.
2. Open an issue in the repository describing the feature contribution you'd like to make. This will help us get you started on the right foot.
3. Commit changes in your feature branch.
4. Open a pull request and reference the initial issue in the pull request message.
2020-02-12 21:33:40 +00:00
### Coding standards
This project follows the [PSR-2](http://www.php-fig.org/psr/psr-2/) coding style guidelines. There are many ways to check your code for PSR-2. An excellent tool is [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer). The command line tool phpcs can be run against any single file. [Phing](https://www.phing.info/), a PHP build tool, integrates nicely with `phpcs` to automate PSR-2 checks across all source files in a project.
2020-03-25 09:24:20 +00:00
2023-11-02 08:48:13 +00:00
### RaspAP community
RaspAP is made possible by a strong [community of developers](https://github.com/RaspAP/raspap-webgui/graphs/contributors). If you have any questions or would like to get involved in RaspAP's community, check out these resources:
2021-01-28 08:29:22 +00:00
2023-11-02 08:48:13 +00:00
* [Github issues](https://github.com/RaspAP/raspap-webgui/issues)
* [Gitter chat](https://app.gitter.im/#/room/#RaspAP:gitter.im)
* [Twitter](https://twitter.com/rasp_ap)
* [Reddit](https://www.reddit.com/r/RaspAP/)