Skip to content

Commit 10abb23

Browse files
authored
Merge pull request #1584 from plone/news-in-packages-not-projects
Update licenses used in Plone and paths to news
2 parents b4a8669 + 3f4eb69 commit 10abb23

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/contributing/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Other chapters cover any variations and additional policies for each project.
2525

2626
You must give permission to the Plone Foundation to publish your contribution, according to the license we use.
2727
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/).
2929
You grant permission by signing and returning the Plone Contributor Agreement.
3030

3131
```{button-link} https://plone.org/foundation/contributors-agreement
@@ -71,15 +71,15 @@ All of a project's CI jobs must pass before a contribution may be accepted.
7171

7272
## Change log entry
7373

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.
7575
This is enforced by continuous integration through GitHub Actions.
7676

7777
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.
8080
Because the log file is automatically generated, you should not edit it directly, except to make corrections, such as broken links.
8181

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.
8383
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.
8484

8585
- `breaking` for breaking changes
@@ -88,7 +88,7 @@ Its format must be `###.type`, where `###` is the referenced GitHub issue or pul
8888
- `feature` for new features
8989
- `internal` for internal changes
9090

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.
9292

9393
The content of this file must include the following.
9494

@@ -98,7 +98,7 @@ The content of this file must include the following.
9898
The following text is an example change log entry, placed inside {file}`/news/4569.documentation`.
9999

100100
```text
101-
Fix broken links for ReactJS.org. @stevepiercy
101+
Fixed broken links for ReactJS.org. @stevepiercy
102102
```
103103

104104
(contributing-project-configuration-files-label)=

0 commit comments

Comments
 (0)