Backstage Plugins

The Backstage plugins that live in this repository are intended to be built, tested, released, and published to npm separately. You can also check out existing plugins on the Backstage plugin marketplace.

Contribution guide

Contributions are welcome. This repository is intended to be open sourced, so please keep changes focused, documented, and easy to review.

How to contribute

1. Fork the repository.

2. Create a branch from main:

   git checkout -b feat/my-change

3. Install dependencies:

   yarn install --immutable

4. Make your change in the relevant plugin folder.

5. Run the checks for the plugin you changed:

   yarn workspace <package-name> lint
   yarn workspace <package-name> test
   yarn workspace <package-name> build

6. Update documentation and tests when behaviour changes.

7. Open a pull request with:

   • a clear description of the change;
   • linked issue or discussion, if applicable;
   • screenshots or API examples for user-facing changes;
   • notes about breaking changes or migration steps.

Contribution standards

• Keep frontend changes inside frontend plugin boundaries.
• Keep backend/service changes inside backend plugin boundaries.
• Do not commit secrets, API tokens, generated credentials, or local .env files.
• Prefer small pull requests over large mixed-scope changes.
• Add or update tests for bug fixes and new features.
• Follow the existing Backstage, TypeScript, linting, and formatting patterns.
• Keep public APIs backward compatible unless a breaking change is clearly documented.

Reporting issues

When opening an issue, include:

• plugin name and version;
• Backstage version;
• Node.js and package manager versions;
• relevant configuration with secrets removed;
• reproduction steps;
• expected and actual behaviour;
• logs or screenshots where useful.

Sponsorship

If these plugins help your team, please consider sponsoring ongoing maintenance:

Sponsor this project on GitHub

Sponsorship helps fund maintenance, security updates, documentation, examples, and new Backstage plugin features.