diff --git a/docs/internals/contributing.mdx b/docs/internals/contributing.mdx new file mode 100644 index 000000000..5e561a559 --- /dev/null +++ b/docs/internals/contributing.mdx @@ -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. + +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. + +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: +... +``` + + +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 diff --git a/website/sidebars.js b/website/sidebars.js index 50c0d8ab1..fa7dd42fd 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -140,6 +140,7 @@ module.exports = { internals: { Internals: [ 'internals/index', + 'internals/contributing', 'extending/public-releases', 'extending/testing-rn', 'internals/linters', diff --git a/website/static/img/changelog.png b/website/static/img/changelog.png new file mode 100644 index 000000000..c3c5bac5e Binary files /dev/null and b/website/static/img/changelog.png differ