-
Notifications
You must be signed in to change notification settings - Fork 34
Code Releases
Frontity keeps the docs updated with the latest features released in the source code.
This is the community discussion regarging this topic: Code <-> Documentation workflow
For every new feature, bug fixing or code update that requires a change in the docs, this is the workflow to follow on both the code repository (code PR) and the docs repostitory (docs PR):
- When the code PR is opened, members of DevRel team should be added as reviewers
- DevRel team will be in charge of opening the proper docs PR in the documentation repository (and all extra tasks or actions required)
- Once the docs PR is created, DevRel team will add a link to it in the code PR and mark the documentation checkbox as checked
- With this link (docs PR), DevRel can approve the code PR
These docs PR associated to code PR cannot be merged until the release of the code is done.
These specific docs PR should be done against a specific branch (named code
) whose only purpose is to store code changes
- Once the PR has been approved the docs PR can be merged (from
XXX-branch
intocode
) - Once the code release is done,
code
branch can be manually merged (fromcode
intomaster
)
Got questions or feedback about Frontity? We'd love to hear from you. Use our community forum yo ! ❤️
Frontity also welcomes contributions. There are many ways to support the project (and get free swag)! If you don't know where to start, this guide might help → How to contribute?