beenull/raspap-webgui-mirror
1
0
Fork 0
mirror of https://github.com/RaspAP/raspap-webgui.git synced 2024-11-22 07:30:23 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update CONTRIBUTING.md

Browse source
This commit is contained in:
Bill Zimmerman 2023-11-02 09:48:13 +01:00 committed by GitHub
parent 5685a4f107
commit 0fbccabaf5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
CONTRIBUTING.md
View file

@ -1,4 +1,5 @@
## How to contribute ## How to contribute
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.
1. Fork the project in your account and create a new branch: `your-great-feature`. 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. 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.
@ -8,6 +9,10 @@
### Coding standards ### 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. 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.
### Development process ### RaspAP community
Development processes used by contributors to the project are described [on this page](https://docs.raspap.com/developers/). It does not endorse one over the other; rather it is meant to share two different approaches. 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:
* [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/)