Skip to content

Commit 3be408f

Browse files
authored
Merge pull request #6130 from kenjis/fix-pull_request.md-Changelog
docs: update about mainly Changelog in contributing/pull_request.md
2 parents d060c86 + 3519efd commit 3be408f

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

contributing/pull_request.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -98,24 +98,31 @@ show up in more than one place.
9898

9999
If you change anything that requires a change to documentation,
100100
then you will need to add to the documentation.
101-
New classes, methods, parameters, changing default values, etc.
101+
New classes, methods, parameters, changing default values, changing behavior etc.
102102
are all changes that require a change to documentation.
103-
Also, the [changelog](https://codeigniter4.github.io/CodeIgniter4/changelogs/index.html) must be updated for every change,
103+
104+
Also, the [Changelog](https://codeigniter4.github.io/CodeIgniter4/changelogs/index.html) must be updated for every change,
104105
and [PHPDoc](https://github.com/codeigniter4/CodeIgniter4/blob/develop/phpdoc.dist.xml) blocks must be maintained.
105106

106107
See [Writing CodeIgniter Documentation](./documentation.rst).
107108

108-
### Changelog
109+
#### Changelog
110+
111+
The [Changelog](https://codeigniter4.github.io/CodeIgniter4/changelogs/index.html), in the user guide, needs to be kept up-to-date. Not
112+
all changes will need an entry in it, but the following items should.
113+
114+
- all breaking changes (BCs)
115+
- all enhancements (new features, new classes, new APIs)
116+
- other behavior changes
117+
- deprecations
118+
- major bug fixes
119+
120+
#### Upgrading Guide
109121

110-
The changelog, in the user guide root, needs to be kept up-to-date. Not
111-
all changes will need an entry in it, but new classes, major or BC
112-
changes to existing classes should. Once we have a stable release, bug
113-
fixes would appear in the changelog too.
122+
If your PR requires users to do something when they upgrade CodeIgniter, the
123+
[Upgrading Guide](https://codeigniter4.github.io/CodeIgniter4/installation/upgrading.html) is also needed.
114124

115-
The changelog is independently maintained by the framework release
116-
manager Make sure that your PR descriptions help us decide if the
117-
contribution should be highlighted in the next release after it has been
118-
merged.
125+
Add an instruction what to do.
119126

120127
### CSS
121128

@@ -138,7 +145,7 @@ break with earlier versions of the framework.
138145

139146
#### Breaking Changes
140147

141-
In general, any change that would disrupt existing uses of the framework is considered a "breaking change" and will not be favorably considered. A few specific examples to pay attention to:
148+
In general, any change that would disrupt existing uses of the framework is considered a "Breaking Change" (BC) and will not be favorably considered. A few specific examples to pay attention to:
142149

143150
1. New classes/properties/constants in `system` are acceptable, but anything in the `app` directory that will be used in `system` should be backwards-compatible.
144151
2. Any changes to non-private methods must be backwards-compatible with the original definition.

0 commit comments

Comments
 (0)