mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
Add info about placing a new CHANGELOG entry to contributing guide
This commit is contained in:
parent
73bbf54868
commit
4e211d3fac
1 changed files with 1 additions and 1 deletions
|
@ -264,7 +264,7 @@ The CHANGELOG is an important part of every release. It keeps the list of change
|
|||
|
||||
You should add an entry to the CHANGELOG of the framework that you modified if you're adding or removing a feature, committing a bug fix or adding deprecation notices. Refactorings and documentation changes generally should not go to the CHANGELOG.
|
||||
|
||||
A CHANGELOG entry should summarize what was changed and should end with author's name. You can use multiple lines if you need more space and you can attach code examples indented with 4 spaces. If a change is related to a specific issue, you should attach issue's number. Here is an example CHANGELOG entry:
|
||||
A CHANGELOG entry should summarize what was changed and should end with author's name and it should go on top of a CHANGELOG. You can use multiple lines if you need more space and you can attach code examples indented with 4 spaces. If a change is related to a specific issue, you should attach issue's number. Here is an example CHANGELOG entry:
|
||||
|
||||
```
|
||||
* Summary of a change that briefly describes what was changed. You can use multiple
|
||||
|
|
Loading…
Reference in a new issue