You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+17-3Lines changed: 17 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,7 @@ We expect all contributions to conform to our [style guide](https://github.com/c
7
7
be documented (in the [user guide](https://codeigniter4.github.io/userguide/)), and unit tested (in the [test folder](https://github.com/codeigniter4/CodeIgniter4/tree/develop/tests)).
8
8
There is a [Contributing to CodeIgniter](./contributing/README.rst) section in the repository which describes the contribution process; this page is an overview.
9
9
10
+
The [Open Source Guide](https://opensource.guide/) is a good first read for those new to contributing to open source!
10
11
## Issues
11
12
12
13
Issues are a quick way to point out a bug. If you find a bug or documentation error in CodeIgniter then please make sure that:
CodeIgniter4 uses the [Git-Flow](http://nvie.com/posts/a-successful-git-branching-model/) branching model which requires all Pull Requests to be sent to the "develop" branch; this is where the next planned version will be developed. The "master" branch will always contain the latest stable version and is kept clean so a "hotfix" (e.g. an emergency security patch) can be applied to the "master" branch to create a new version, without worrying about other features holding it up. For this reason, all commits need to be made to the "develop" branch, and any sent to the "master" branch will be closed automatically. If you have multiple changes to submit, please place all changes into their own branch on your fork.
43
-
44
-
**One thing at a time:** A pull request should only contain one change. That does not mean only one commit, but one change - however many commits it took. The reason for this is that if you change X and Y, but send a pull request for both at the same time, we might really want X but disagree with Y, meaning we cannot merge the request. Using the Git-Flow branching model you can create new branches for both of these features and send two requests.
43
+
CodeIgniter4 uses the [Git-Flow](http://nvie.com/posts/a-successful-git-branching-model/) branching model which requires all
44
+
Pull Requests to be sent to the "develop" branch; this is where the next planned version will be developed.
45
+
The "master" branch will always contain the latest stable version and is kept clean so a "hotfix" (e.g. an
46
+
emergency security patch) can be applied to the "master" branch to create a new version, without worrying
47
+
about other features holding it up. For this reason, all commits need to be made to the "develop" branch,
48
+
and any sent to the "master" branch will be closed automatically. If you have multiple changes to submit,
49
+
please place all changes into their own branch on your fork.
50
+
51
+
**One thing at a time:** A pull request should only contain one change. That does not mean only one commit,
52
+
but one change - however many commits it took. The reason for this is that if you change X and Y,
53
+
but send a pull request for both at the same time, we might really want X but disagree with Y,
54
+
meaning we cannot merge the request. Using the Git-Flow branching model you can create new
55
+
branches for both of these features and send two requests.
56
+
57
+
A reminder: **please use separate branches for each of your PRs** - it will make it easier for you to keep changes separate from
58
+
each other and from whatever else you are doing with your repository!
0 commit comments