diff --git a/README.md b/README.md index eaec737..eb73ae5 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,17 @@ If you need a admin panel check out [Moe Panel](https://github.com/pomf/MoePanel Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se +## Contributing + +We'd really like if you can take some time to make sure your coding style is +consistent with the project. Uguu follows [PHP +PSR-12](https://www.php-fig.org/psr/psr-12/) and [Airbnb JavaScript +(ES5)](https://github.com/airbnb/javascript/tree/es5-deprecated/es5) (`airbnb/legacy`) +coding style guides. We use ESLint and PHPCS tools to enforce these standards. + +You can also help by sending us feature requests or writing documentation and +tests. + ## Credits Uguu is based on [Pomf](http://github.com/pomf/pomf) which was written by Emma Lejack & Eric Johansson (nekunekus) and with help from the open source community.