Skip to content

Commit d6814b7

Browse files
authored
Merge pull request #8853 from kenjis/update-contributing/pull_request.md
docs: update contributing/pull_request.md
2 parents ac06cff + 3da5beb commit d6814b7

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

contributing/pull_request.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,24 @@
22

33
## Contributions
44

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)).
5+
We expect the following in all Pull Requests (PRs).
6+
- PRs must be sent to the [appropriate branch](#branching)
7+
- All git commits must be [GPG-signed](#signing)
8+
- Must follow our [style guide](#php-style)
9+
- Be [commented](#comments) in the PHP source file
10+
- Be documented in the [user guide](#user-guide)
11+
- Be [unit tested](#unit-testing)
12+
- Pass all checks in GitHub Actions
1013

1114
> [!IMPORTANT]
1215
> We expect all code changes or bug-fixes to be accompanied by one or more tests
1316
> added to our test suite to prove the code works.
1417
15-
If pull requests are not accompanied by relevant tests, they will likely be closed.
18+
If pull requests do not comply with the above, they will likely be closed.
1619
Since we are a team of volunteers, we don't have any more time to work on the
1720
framework than you do. Please make it as painless for your contributions to be
1821
included as possible.
1922

20-
If you need help with getting tests running on your local machines, ask for help
21-
on the [forum](https://forum.codeigniter.com/forumdisplay.php?fid=27). We would
22-
be happy to help out.
23-
2423
The [Open Source Guide](https://opensource.guide/) is a good first read for those
2524
new to contributing to open source!
2625

@@ -67,13 +66,18 @@ composer cs
6766

6867
If you are not familiar with Unit Testing, see
6968
[the forum thread](https://forum.codeigniter.com/showthread.php?tid=81830).
69+
If you need help with getting tests running on your local machines, ask for help
70+
on the [forum](https://forum.codeigniter.com/forumdisplay.php?fid=27). We would
71+
be happy to help out.
7072

7173
Unit testing is expected for all CodeIgniter components. We use PHPUnit,
7274
and run unit tests using GitHub Actions for each PR submitted or changed.
7375

74-
In the CodeIgniter project, there is a `tests` folder, with a structure
76+
In the CodeIgniter project, there is a [tests][tests-folder] folder, with a structure
7577
that parallels that of `system`.
7678

79+
[tests-folder]: https://github.com/codeigniter4/CodeIgniter4/tree/develop/tests
80+
7781
The normal practice would be to have a unit test class for each of the
7882
classes in `system`, named appropriately. For instance, the `BananaTest`
7983
class would test the `Banana` class. There will be occasions when it is
@@ -199,7 +203,7 @@ working on your contribution.
199203
All bug fixes should be sent to the __"develop"__ branch, this is where the next
200204
bug fix version will be developed.
201205

202-
PRs with any enhancement should be sent to next minor version branch, e.g. __"4.5"__
206+
PRs with any enhancement should be sent to next minor version branch, e.g. __"4.6"__
203207

204208
The __"master"__ branch will always contain the latest stable version and is kept
205209
clean so a "hotfix" (e.g. an emergency security patch) can be applied to the
@@ -300,7 +304,7 @@ GitHub means "making a copy of that repo to your account" and "cloning" means
300304
- If your PR is for bug fixes:
301305
- `> git switch develop`
302306
- `> git switch -c <new-branch-name>`
303-
- If your PR has any enhancement, create new branch from next minor version branch, e.g. __"4.5"__:
307+
- If your PR has any enhancement, create new branch from next minor version branch, e.g. __"4.6"__:
304308
- `> git switch <next-minor-version-branch>`
305309
- `> git switch -c <new-branch-name>`
306310
7. Fix existing bugs on the [Issue tracker](https://github.com/codeigniter4/CodeIgniter4/issues) after confirming that no one

0 commit comments

Comments
 (0)