diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9f709a05d..864f9fbcf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -61,7 +61,17 @@ Pull requests When creating pull request, please heed the following: -* Base your code on the latest master branch to avoid manual merges -* Code review may ensue in order to help shape your proposal +* Base your code on the latest `master` branch to avoid manual merges +* Code review by the team may occur to help you shape your proposal +* Test your proposal operationally to catch mistakes and avoid merge delay * Pull request must adhere to 2-Clause BSD licensing * Explain the problem and your proposed solution +* If applicable cite the issue(s) number(s) in your pull-request description, + for example `Fixes: #1234`, `Closes: #1234`, or `Ref: #1234`. +* Read [README.md](./README.md) to learn about the commands to shape your code + +Stable release updates +---------------------- + +After merging a pull-request into the `master` branch a team member may cherry-pick +your work to update the current stable version (branches: `stable/.`). diff --git a/README.md b/README.md index 1ca39d155..48ab1797a 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,8 @@ You can contribute to the project in many ways, e.g. testing functionality, sending in bug reports or creating pull requests directly via GitHub. Any help is always very welcome! +You can learn more about contributing on [CONTRIBUTING.md](./CONTRIBUTING.md). + License ======= @@ -104,8 +106,15 @@ before issuing a pull request on GitHub. make style ---------- -Run the PSR2 and PEP8 style checks on MVC PHP code and Python, +Run the PSR12 and PEP8 style checks on MVC PHP code and Python, respectively. +For php code you will need to have `phpcs` and `phpcbf` installed. + +You can use the package `php-codesniffer` on Debian/Ubuntu. +Python code will require `pycodestyle`. + +For easier development you may want to use an OPNsense VM and run: +`pkg install os-debug` that will install all the necessary tools. make sweep ----------