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: docs/contributing/index.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ Other chapters cover any variations and additional policies for each project.
25
25
26
26
You must give permission to the Plone Foundation to publish your contribution, according to the license we use.
27
27
Plone uses the [GNU General Public License, version 2](https://github.com/plone/Products.CMFPlone/blob/master/LICENSE) for most of its projects and for any new projects.
28
-
A few other projects use the [modified BSD license](https://opensource.org/license/bsd-3-clause/).
28
+
A few other projects use the [modified BSD license](https://opensource.org/license/bsd-3-clause/), [MIT License](https://opensource.org/license/mit/), or [Creative Commons Attribution-ShareAlike 4.0 International license](https://creativecommons.org/licenses/by-sa/4.0/).
29
29
You grant permission by signing and returning the Plone Contributor Agreement.
@@ -71,15 +71,15 @@ All of a project's CI jobs must pass before a contribution may be accepted.
71
71
72
72
## Change log entry
73
73
74
-
Plone projects require that you include a change log entry or news item with your contribution.
74
+
Plone packages require that you include a change log entry or news item with your contribution.
75
75
This is enforced by continuous integration through GitHub Actions.
76
76
77
77
Plone uses [`towncrier`](https://github.com/collective/zestreleaser.towncrier) to manage change log entries and to automatically generate history or change log files from the entries.
78
-
The log file is usually named `CHANGES.rst`, `CHANGES.md`, or `CHANGELOG.md`, and is located at the root of the project.
79
-
When a project is released with a new version, the release manager runs `towncrier` as part of the release process.
78
+
The log file is usually named `CHANGES.rst`, `CHANGES.md`, or `CHANGELOG.md`, and is located at the root of the package.
79
+
When a package is released with a new version, the release manager runs `towncrier` as part of the release process.
80
80
Because the log file is automatically generated, you should not edit it directly, except to make corrections, such as broken links.
81
81
82
-
To create a change log entry or news item, create a file that is placed in the root of the repository directory at `/news`.
82
+
To create a change log entry or news item, create a file in the `news` directory, located in the root of the package.
83
83
Its format must be `###.type`, where `###` is the referenced GitHub issue or pull request number, `.` is the literal extension delimiter, and `type` is one of the following strings.
84
84
85
85
-`breaking` for breaking changes
@@ -88,7 +88,7 @@ Its format must be `###.type`, where `###` is the referenced GitHub issue or pul
88
88
-`feature` for new features
89
89
-`internal` for internal changes
90
90
91
-
A project configures the types it allows in a file `towncrier.toml` located at the root of its repository.
91
+
A package configures the types it allows in a file `towncrier.toml` located at the root of its package directory.
92
92
93
93
The content of this file must include the following.
94
94
@@ -98,7 +98,7 @@ The content of this file must include the following.
98
98
The following text is an example change log entry, placed inside {file}`/news/4569.documentation`.
0 commit comments