Skip to content

Latest commit

 

History

History
78 lines (45 loc) · 3.89 KB

CONTRIBUTING.md

File metadata and controls

78 lines (45 loc) · 3.89 KB
Raw

Contributing to Axis Backstage plugins

Contributions are welcome and greatly appreciated! We are committed to improving our plugins ✨

These contributing guidelines explain:

  • How to contribute effectively for optimal communication
  • The conventions we would like you to follow

If you have any questions, please let us know!

Code of Conduct

This project adheres to the CNCF Code of Conduct. By participating, you are expected to honor this code.

How can I contribute?

1. Create Issue

We welcome anything from bug fixes to new features. Please start by creating an issue in our repository. The Axis Backstage team will respond as soon as possible regarding:

  • Whether this is an implementation we want in our main repository
  • If there are any points to discuss before implementing the feature
  • Who should implement the feature

2. Create Pull Request

Pull Request Best Practises

Once the discussion in the issue is complete, you are welcome to create a Pull Request (PR). We follow GitHub's best practices for creating pull Requests. Please review these guidelines if you are not familiar with them.

In addition, provide a clear title for your PR that explains the change.

Pull Request Approval

After submitting a PR, tests will run and the team will review it as soon as possible. If there are any comments or questions, we will communicate through the PR.

You need approval from one of the core maintainers (the Axis Backstage team). Once you have approval, the PR is ready to be merged. This task will also be done by one of us.

Other contributing guidelines

As a contributor, here are the guidelines we would like you to follow:

Api reports

Similar to Backstage upstream, we use api reports generated by API Extractor to help us build better TypeScript library packages. To learn more about api-reports and how to generate them, we refer to the upstream documentation.

Changesets

Just like Backstage upstream, we use changesets to help us prepare releases. By using changsets we can make sure that the process generating releases is easy, and that every change gets a proper version number.

If you wish to know more about the use of changesets in Backstage, please read the official Backstage documentation about changesets.

How to create a changeset

  1. Run yarn changeset from the root of the repo
  2. Select which packages you want to include a changeset for
  3. Select if you wish to use the minor, major, or patch impact. Read more here about when to use which impact.
  4. Describe your changes in the generated changeset. Backstage upstream has [a well-written guide](https://github.com/backstage/backstage/blob/master/CONTRIBUTING.md#Writing changesets) for how to write these descriptions.
  5. Add generated changeset to Git and push this commit to the branch associated with your PR.

Styling conventions

All code in our plugin is formatted with prettier. We recommend you to always run the following command to format files:

$ yarn prettier:fix <file>

(or even better, configure your editor to format automatically 💥).

The backstage-plugins repository use ESLint for linting. You can run the following command to packages that have changed since later commit on origin/main.

$ yarn lint