Skip to content

Commit e824a74

Browse files
committed
Update README documentation
1 parent bb22bdd commit e824a74

File tree

5 files changed

+17
-19
lines changed

5 files changed

+17
-19
lines changed

.github/workflows/main.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ jobs:
5151
backend:
5252
- 'backend/**'
5353
- '.github/workflows/backend.yml'
54+
- '.github/workflows/backend-release.yml'
5455
frontend:
5556
- 'frontend/**'
5657
- '.github/workflows/frontend.yml'

CHANGELOG.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Changes
1+
# Changelog
22

3-
## 1.0.0 (2025-02-23)
4-
5-
- Initial version [plonegovbr]
3+
<!-- towncrier release notes start -->

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,19 @@ This monorepo hosts two packages:
7676
- **backend/**: Python package `plonegovbr.brfields` for Plone Dexterity fields.
7777
- **frontend/**: React package `@plonegovbr/volto-brwidgets` for Volto widgets.
7878

79-
## Code Quality Assurance 🧐
79+
## Contributing 🤝
80+
81+
Contributions are welcome! If you find any issues or want to suggest improvements, please check out:
82+
83+
- [Source Code](https://github.com/plonegovbr/brfieldsandwidgets/) 💻
84+
- [Issue Tracker](https://github.com/plonegovbr/brfieldsandwidgets/issues) 🐛
85+
86+
Every pull request requires a [Change log entruy](https://6.docs.plone.org/contributing/index.html#change-log-entry). The location of the `news` folder is the following:
87+
88+
- **backend**: `backend/news`
89+
- **frontend**: `frontend/packages/volto-brwidgets/news`
90+
91+
### Code Quality Assurance 🧐
8092

8193
Ensure your code follows best practices by running the following commands:
8294

@@ -94,7 +106,7 @@ make lint
94106

95107
You can also run these commands separately in the `backend` or `frontend` folders.
96108

97-
## Internationalization 🌐
109+
### Internationalization 🌐
98110

99111
Easily generate translation files for both Plone and Volto:
100112

backend/CHANGELOG.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
11
# Changelog
22

3-
<!--
4-
You should *NOT* be adding new change log entries to this file.
5-
You should create a file in the news directory instead.
6-
For helpful instructions, please see:
7-
https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst
8-
-->
9-
103
<!-- towncrier release notes start -->
Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
11
# Changelog
22

3-
<!-- You should *NOT* be adding new change log entries to this file.
4-
You should create a file in the news directory instead.
5-
For helpful instructions, please see:
6-
https://6.docs.plone.org/volto/developer-guidelines/contributing.html#create-a-pull-request
7-
-->
8-
93
<!-- towncrier release notes start -->

0 commit comments

Comments
 (0)