Add a note about changelogs

Summary:
LukeDefeo called out that there's currently no guide for how to create changelog items.

I couldn't find another good page to add this to. Might be a good idea to expand this with further tips for making good contributions.

Reviewed By: LukeDefeo, nikoant

Differential Revision: D36702634

fbshipit-source-id: 15bc1dcf420ea923a714929eff8ac817efa56ceb
This commit is contained in:
Pascal Hartig
2022-05-30 03:44:28 -07:00
committed by Facebook GitHub Bot
parent db045a3b21
commit 8c4b494d32
3 changed files with 44 additions and 0 deletions

View File

@@ -0,0 +1,43 @@
---
id: contributing
title: Contributing
---
import useBaseUrl from '@docusaurus/useBaseUrl';
Some notes about making contributions to the Flipper codebase.
## Changelog Entries
We show a changelog dialog when a new version of Flipper is started for the first time.
It can also be seem by clicking on the button next to the version number in the welcome screen.
<img alt="The changelog dialog in Flipper" src={useBaseUrl("img/changelog.png")} />
The content is automatically generated during the release process. You should
always include a changelog entry if there is a user-visible change in your commit.
To contribute a message, include a note in the body of your commit like in example below.
Please note that unlike other blocks that Phabricator expects (e.g. "Summary" and "Test Plan"),
the changelog can only be a single line. The spelling is not case-sensitive.
```
[layout] Add Unicorn support
Summary:
Finally, the moment we've all been waiting for: Unicorn support!
Changelog: Unicorns can be inspected in the Layout Plugin
Test Plan:
...
```
<FbInternalOnly>
For internal-only changes, prefix your line with `Facebook Changelog:`.
Entries made this way will only show up in internal builds.
</FbInternalOnly>
### Implementation
You can find the code for the changelog generation in
[`desktop/scripts/generate-changelog.js`](https://github.com/facebook/flipper/blob/main/desktop/scripts/generate-changelog.js).

View File

@@ -140,6 +140,7 @@ module.exports = {
internals: {
Internals: [
'internals/index',
'internals/contributing',
'extending/public-releases',
'extending/testing-rn',
'internals/linters',

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB