Skip to content

Latest commit

 

History

History
108 lines (67 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

108 lines (67 loc) · 2.46 KB
Raw

Contributing

Commit naming

We use conventional changelogs for commits and PR names

It should be like:

<type>[optional scope]: <description>

[optional body]

[optional footer]
  • with type = feat/fix/refactor/chore/docs/test/…
  • description should be lowercase and start with a verb

Here are some examples https://www.conventionalcommits.org/en/v1.0.0-beta.4/#examples

Running flashlight commands locally

Start by building the whole project:

At the root of the repo:

yarn
yarn watch

Keep this open in one terminal.

measure command

Start the webapp with

yarn workspace @perf-profiler/measure start

Then run the measure commmand with:

DEVELOPMENT_MODE=true node packages/commands/measure/dist/server/bin.js measure

test command

To run the command locally:

node packages/commands/test/dist/bin.js test

This command is the equivalent of

flashlight test

tools command

To run the command locally:

node packages/commands/tools/dist/bin.js tools

This command is the equivalent of

flashlight tools

web-reporter

Run in another terminal:

yarn workspace @perf-profiler/web-reporter start

Then in packages/commands/report/src/App.tsx, uncomment the lines to add your own measures:

// Uncomment with when locally testing
// eslint-disable-next-line @typescript-eslint/no-var-requires
testCaseResults = [require("../measures.json")];

You should now be able to open the local server

Run yarn jest Plugin -u after modifications.

Flipper plugin

  • Add the path to the packages folder in ~/.flipper/config.json.

For instance, my config.json is currently {"pluginPaths":["/Users/almouro/dev/projects/android-performance-profiler/packages"],"disabledPlugins":[],"darkMode":"system","updaterEnabled":true,"launcherEnabled":true,"lastWindowPosition":{"x":-195,"y":-1415,"width":1280,"height":1415}}

  • in the packages/flipper-plugin-android-performance-profiler, run yarn watch.

You should now see your local plugin in Flipper (ensure you have uninstalled the one from the marketplace), in the disabled plugin section if you're installing for the first time.

⚠️ when modifying files outside of the packages/flipper-plugin-android-performance-profiler, live reload sometimes doesn't work and you need to re-run yarn watch for changes to take effect 😕