Skip to content

Commit

Permalink
Merge pull request codeigniter4#6141 from kenjis/fix-docs-contrib-PR
Browse files Browse the repository at this point in the history
docs: update for branch model change
  • Loading branch information
kenjis authored Jun 17, 2022
2 parents 0fe1ed1 + 2ab2c3a commit 7b2ed47
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 13 deletions.
5 changes: 3 additions & 2 deletions contributing/pull_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,8 +171,9 @@ PRs with any enhancement should be sent to next minor version branch, e.g. __"4.

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,
about other features holding it up. 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.

**One thing at a time:** A pull request should only contain one change. That does not mean only one commit,
Expand Down
22 changes: 11 additions & 11 deletions contributing/workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,16 @@ values for when you try these:

## Branching

CodeIgniter 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
- All bug fix PRs should be sent to the __"develop"__ branch, this is where the next bug fix version will be developed.
- PRs with any enhancement should be sent to next minor version branch, e.g. __"4.3"__

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 master to create a new version, without
worrying about other features holding it up. For this reason, all
commits need to be made to "develop" and any sent to "master" will be
closed automatically. If you have multiple changes to submit, please
worrying about other features holding it up. Any sent to "master" will be
closed automatically.

If you have multiple changes to submit, please
place each change into their own branch on your fork.

One thing at a time: a pull request should only contain one change. That
Expand Down Expand Up @@ -64,7 +64,7 @@ Clone your repository, leaving a local folder for you to work with:
cd ALL_PROJECTS
git clone ORIGIN_URL

## Syncing develop
## Syncing your repository

Within your local repository, Git will have created an alias,
**origin**, for the GitHub repository it is bound to. You want to create
Expand Down Expand Up @@ -177,7 +177,7 @@ On GitHub, you propose your changes one feature branch at a time, by
switching to the branch you wish to contribute, and then clicking on
"New pull request".

Make sure the pull request is for the shared **develop** branch, or it
Make sure the pull request is for the shared __"develop"__ or next minor version branch, e.g. __"4.3"__, or it
may be rejected.

Make sure that the PR title is helpful for the maintainers and other
Expand Down Expand Up @@ -218,7 +218,7 @@ And if your PRs have the breaking changes, label the following label:

If you are asked for changes in the review, commit the fix in your branch and push it to GitHub again.

If the `develop` branch progresses and conflicts arise that prevent merging, or if you are asked to *rebase*,
If the __"develop"__ or next minor version branch, e.g. __"4.3"__, progresses and conflicts arise that prevent merging, or if you are asked to *rebase*,
do the following:

Synchronize your repository:
Expand Down

0 comments on commit 7b2ed47

Please sign in to comment.