Skip to content

Commit 0b63c4a

Browse files
authored
Merge pull request #1646 from plone/clarify-volto-news-items
Clarify where to place Volto news items
2 parents 1878587 + 51ab426 commit 0b63c4a

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/contributing/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,10 @@ When a package is released with a new version, the release manager runs `towncri
8686
Because the log file is automatically generated, you should not edit it directly, except to make corrections, such as broken links.
8787

8888
To create a change log entry or news item, create a file in the `news` directory, located in the root of the package.
89+
8990
For Volto, its repository is in a monorepo structure, consisting of several packages in the `packages` folder.
9091
Thus for Volto and its packages, change log entries should be created in `packages/PACKAGE_NAME/news/`, which is the root of the package.
92+
When making a change to its documentation, set up, continuous integration, or other repository-wide items, place a change log entry in `packages/volto/news/` as a default.
9193

9294
The change log entry's 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.
9395

0 commit comments

Comments
 (0)