jens/flipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

contributing.mdx (Under the Hood - Contributing Code)

Browse Source 
Summary:
Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).
This title of the page has changed as there will be a new section called 'Contributing to the Documentation'

Reviewed By: lblasa

Differential Revision: D37003755

fbshipit-source-id: bc2412e371c941e87e25429fe801f4c3e7148f9c
This commit is contained in:
Kevin Strider
2022-06-09 04:43:02 -07:00
committed by Facebook GitHub Bot
parent fec2650afb
commit d230cbfba1
1 changed files with 13 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/internals/contributing.mdx
View File

@@ -1,26 +1,26 @@
---
id: contributing
title: Contributing
title: Contributing to the Codebase
---
import useBaseUrl from '@docusaurus/useBaseUrl';
Some notes about making contributions to the Flipper codebase.
This page contains information that helps you make 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.
A changelog dialog is displayed when a new version of Flipper is started for the first time. It can also be seen 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.
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.
```
:::note
Unlike other blocks that Phabricator expects (such as 'Summary' and 'Test Plan'), the changelog can only be a single line. The spelling is not case-sensitive.
:::
```bash
[layout] Add Unicorn support
Summary:
@@ -33,11 +33,13 @@ 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).
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).