raspap-webgui-mirror/CONTRIBUTING.md
2023-11-02 14:46:32 +01:00

2 KiB

How to contribute

Everyone is invited and welcome to contribute to RaspAP. There's a lot to do — if you're not a developer we can always use help with the official project documentation. If you have experience in Linux networking, you can share your knowledge by answering questions from RaspAP users in our GitHub discussions and/or the /r/RaspAP subreddit.

If you're a devloper, the process of contributing code is straightforward:

  1. Fork the project in your account and create a new branch: feat/your-feature or fix/your-bugfix.
  2. Open an issue describing the feature or bug fix contribution you'd like to make.
  3. Commit changes in your branch.
  4. Open a pull request and reference the initial issue in the pull request message, or by linking it in GitHub.

Coding standards

This project follows the PSR-2 coding style guidelines. There are many ways to check your code for PSR-2. An excellent tool is PHP_CodeSniffer. The command line tool phpcs can be run against any single file. Phing, a PHP build tool, integrates nicely with phpcs to automate PSR-2 checks across all source files in a project.

RaspAP community

RaspAP is made possible by a strong community of developers. If you have any questions or would like to get involved in RaspAP, dive into any of these channels:

If you enjoy using RaspAP and would like to support our work financially, consider becoming an Insider.