Backstage
/
community-plugins
mirror of https://github.com/backstage/community-plugins.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: clean up contributing instructions (#3910) 

Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
This commit is contained in:
Vincenzo Scamporlino 2025-05-05 20:04:37 +02:00 committed by GitHub
parent af81e5a1fc
commit 7619a99df7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@ -190,7 +190,7 @@ By migrating a plugin to this repository you will need to ensure you can meet ce
1. Prepare your environment by cloning both the repository you are migrating from and the `backstage/community-plugins` repository:
```sh
git clone https://github.com/source-repo/existing-plugins.git
git clone https://github.com/<source-repo>/existing-plugins.git
git clone https://github.com/backstage/community-plugins.git
```

15
workspaces/analytics/plugins/analytics-provider-segment/CONTRIBUTING.md
View File

@ -3,14 +3,15 @@
If you would like to contribute improvements to this plugin, the easiest way to
make and test changes is to do the following:
> 1. Clone the main Backstage monorepo `git clone git@github.com:backstage-community/backstage-plugins.git`
> 1. Clone the main Backstage monorepo `git clone git@github.com:backstage/community-plugins.git`
> 2. Install all dependencies `yarn install`
> 3. If one does not exist, create an `app-config.local.yaml` file in the root of
> the monorepo and add config for this plugin (see below)
> 4. Enter this plugin's working directory: `cd plugins/analytics-provider-segment`
> 5. Start the plugin in isolation: `yarn start`
> 6. Navigate to the playground page at `http://localhost:3000/segment`
> 7. Open the web console to see events fire when you navigate or when you
> 3. Navigate to the analytics' workspace `cd workspaces/analytics`
> 4. If one does not exist, create an `app-config.local.yaml` file and add config for this plugin (see below)
> 5. Install the dependencies for the workspace `yarn install`
> 6. Enter this plugin's working directory: `cd plugins/analytics-provider-segment`
> 7. Start the plugin in isolation: `yarn start`
> 8. Navigate to the playground page at `http://localhost:3000/segment`
> 9. Open the web console to see events fire when you navigate or when you
> interact with instrumented components.
Code for the isolated version of the plugin can be found inside the `./dev`