|
2 | 2 |
|
3 | 3 | ## Contributions |
4 | 4 |
|
5 | | -We expect all contributions to conform to our |
6 | | -[style guide](https://github.com/codeigniter4/CodeIgniter4/blob/develop/contributing/styleguide.md), |
7 | | -be commented (inside the PHP source files), be documented (in the |
8 | | -[user guide](https://codeigniter4.github.io/userguide/)), and unit tested (in |
9 | | -the [test folder](https://github.com/codeigniter4/CodeIgniter4/tree/develop/tests)). |
10 | | - |
11 | | -Note, we expect all code changes or bug-fixes to be accompanied by one or more tests added to our test suite |
12 | | -to prove the code works. If pull requests are not accompanied by relevant tests, they will likely be closed. |
| 5 | +We expect all contributions to |
| 6 | +- conform to our [style guide](./styleguide.md), |
| 7 | +- be commented (inside the PHP source files), |
| 8 | +- be documented (in the [user guide](https://codeigniter4.github.io/userguide/)), |
| 9 | +- and unit tested (in the [test folder](https://github.com/codeigniter4/CodeIgniter4/tree/develop/tests)). |
| 10 | + |
| 11 | +> [!NOTE] |
| 12 | +> We expect all code changes or bug-fixes to be accompanied by one or more tests |
| 13 | +> added to our test suite to prove the code works. |
| 14 | +
|
| 15 | +If pull requests are not accompanied by relevant tests, they will likely be closed. |
13 | 16 | Since we are a team of volunteers, we don't have any more time to work on the framework than you do. Please |
14 | | -make it as painless for your contributions to be included as possible. If you need help with getting tests |
15 | | -running on your local machines, ask for help on the forums. We would be happy to help out. |
| 17 | +make it as painless for your contributions to be included as possible. |
| 18 | + |
| 19 | +If you need help with getting tests running on your local machines, ask for help |
| 20 | +on the [forum](https://forum.codeigniter.com/forumdisplay.php?fid=27). We would |
| 21 | +be happy to help out. |
16 | 22 |
|
17 | 23 | The [Open Source Guide](https://opensource.guide/) is a good first read for those new to contributing to open source! |
18 | 24 |
|
|
0 commit comments