diff --git a/docs/internals/contributing.mdx b/docs/internals/contributing.mdx index 5e561a559..8177c798f 100644 --- a/docs/internals/contributing.mdx +++ b/docs/internals/contributing.mdx @@ -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. The changelog dialog in Flipper -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: ``` + For internal-only changes, prefix your line with `Facebook Changelog:`. + Entries made this way will only show up in internal builds. + ### 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). \ No newline at end of file +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).