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
Numerous updates were made to the CONTRIBUTING.md file in order to make the project more welcoming to new FOSS contributors. A number of inline links were added to facilitate learning of version control jargon.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+24-25Lines changed: 24 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,65 +15,64 @@ Issues are a quick way to point out a bug. If you find a bug or documentation er
15
15
2. The Issue has not already been fixed (check the develop branch or look for [closed Issues](https://github.com/codeigniter4/CodeIgniter4/issues?q=is%3Aissue+is%3Aclosed))
16
16
3. It's not something really obvious that you can fix yourself
17
17
18
-
Reporting Issues is helpful, but an even [better approach](./contributing/workflow.rst) is to send a Pull Request, which is done by ["Forking"](https://help.github.com/en/articles/fork-a-repo) the main repository and making a [commit](https://help.github.com/en/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project) to your own copy of the project. This will require you to use the version control system called [Git](https://git-scm.com/).
18
+
Reporting Issues is helpful, but an even [better approach](./contributing/workflow.rst) is to send a [Pull Request](https://help.github.com/en/articles/creating-a-pull-request), which is done by [Forking](https://help.github.com/en/articles/fork-a-repo) the main repository and making a [Commit](https://help.github.com/en/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project) to your own copy of the project. This will require you to use the version control system called [Git](https://git-scm.com/).
19
19
20
20
## Guidelines
21
21
22
-
Before we look into how, here are the guidelines. If your Pull Requests fail
23
-
to pass these guidelines it will be declined and you will need to re-submit
22
+
Before we look into how to contribute to CodeIgniter4, here are some guidelines. If your Pull Requests fail
23
+
to pass these guidelines, they will be declined, and you will need to re-submit
24
24
when you’ve made the changes. This might sound a bit tough, but it is required
25
-
for us to maintain quality of the code-base.
25
+
for us to maintain quality of the codebase.
26
26
27
27
### PHP Style
28
28
29
29
All code must meet the [Style Guide](./contributing/styleguide.rst).
30
-
This makes certain that all code is the same format as the existing code and means it will be as readable as possible.
30
+
This makes certain that all submitted code is of the same format as the existing code and ensures that the codebase will be as readable as possible.
31
31
32
32
### Documentation
33
33
34
-
If you change anything that requires a change to documentation then you will need to add it. New classes, methods, parameters, changing default values, etc are all things that will require a change to documentation. The change-log must also be updated for every change. Also PHPDoc blocks must be maintained.
34
+
If you change anything that requires a change to documentation, then you will need to add to the documentation. New classes, methods, parameters, changing default values, etc. are all changes that require a change to documentation. Also, the [changelog](https://codeigniter4.github.io/CodeIgniter4/changelogs/index.html)must be updated for every change, and [PHPDoc](https://github.com/codeigniter4/CodeIgniter4/blob/develop/phpdoc.dist.xml) blocks must be maintained.
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
43
-
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 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 place all changes into their own branch on your fork.
42
+
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.
44
43
45
-
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.
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.
46
45
47
46
### Signing
48
47
49
-
You must [GPG-sign](./contributing/signing.rst) your work, certifying that you either wrote the work or otherwise have the right to pass it on to an open source project. This is *not* just a "signed-off-by" commit, but instead a digitally signed one.
48
+
You must [GPG-sign](./contributing/signing.rst) your work, certifying that you either wrote the work or otherwise have the right to pass it on to an open source project. This is *not* just a "signed-off-by" commit, but instead, a digitally signed one.
50
49
51
50
## How-to Guide
52
51
53
52
The best way to contribute is to fork the CodeIgniter4 repository, and "clone" that to your development area. That sounds like some jargon, but "forking" on GitHub means "making a copy of that repo to your account" and "cloning" means "copying that code to your environment so you can work on it".
54
53
55
-
1. Set up Git (Windows, Mac & Linux)
56
-
2. Go to the CodeIgniter4 repo
57
-
3. Fork it (to your Github account)
58
-
4. Clone your CodeIgniter repo: git@github.com:\<your-name>/CodeIgniter4.git
59
-
5. Create a new branch in your project for each set of changes you want to make.
60
-
6. Fix existing bugs on the Issue tracker after taking a look to see nobody else is working on them.
61
-
7. Commit the changed files in your contribution branch
62
-
8. Push your contribution branch to your fork
63
-
9. Send a pull request[http://help.github.com/send-pull-requests/](http://help.github.com/send-pull-requests/)
54
+
1. Set up Git ([Windows](https://git-scm.com/download/win), [Mac](https://git-scm.com/download/mac), & [Linux](https://git-scm.com/download/linux)).
55
+
2. Go to the [CodeIgniter4 repository](https://github.com/codeigniter4/CodeIgniter4).
56
+
3.[Fork](https://help.github.com/en/articles/fork-a-repo) it (to your Github account).
57
+
4.[Clone](https://help.github.com/en/articles/cloning-a-repository) your CodeIgniter repository: `git@github.com:\<your-name>/CodeIgniter4.git`
58
+
5. Create a new [branch](https://help.github.com/en/articles/about-branches) in your project for each set of changes you want to make.
59
+
6. Fix existing bugs on the [Issue tracker](https://github.com/codeigniter4/CodeIgniter4/issues) after confirming that no one else is working on them.
60
+
7.[Commit](https://help.github.com/en/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project) the changed files in your contribution branch.
61
+
8.[Push](https://help.github.com/en/articles/pushing-to-a-remote) your contribution branch to your fork.
62
+
9. Send a [pull request](http://help.github.com/send-pull-requests/).
64
63
65
-
The codebase maintainers will now be alerted about the change and at least one of the team will respond. If your change fails to meet the guidelines it will be bounced, or feedback will be provided to help you improve it.
64
+
The codebase maintainers will now be alerted to the submission and someone from the team will respond. If your change fails to meet the guidelines, it will be rejected or feedback will be provided to help you improve it.
66
65
67
-
Once the maintainer handling your pull request is happy with it they will merge it into develop and your patch will be part of the next release.
66
+
Once the maintainer handling your pull request is satisfied with it they will approve the pull request and merge it into the "develop" branch; your patch will now be part of the next release!
68
67
69
68
### Keeping your fork up-to-date
70
69
71
-
Unlike systems like Subversion, Git can have multiple remotes. A remote is the name for a URL of a Git repository. By default your fork will have a remote named "origin" which points to your fork, but you can add another remote named "codeigniter" which points to `git://github.com/codeigniter4/CodeIgniter4.git`. This is a read-only remote but you can pull from this develop branch to update your own.
70
+
Unlike systems like Subversion, Git can have multiple remotes. A remote is the name for the URL of a Git repository. By default, your fork will have a remote named "origin", which points to your fork, but you can add another remote named "codeigniter", which points to `git://github.com/codeigniter4/CodeIgniter4.git`. This is a read-only remote, but you can pull from this develop branch to update your own.
72
71
73
-
If you are using command-line you can do the following:
72
+
If you are using the command-line, you can do the following to update your fork to the latest changes:
0 commit comments