Skip to content

Latest commit

 

History

History
87 lines (60 loc) · 2.35 KB

CONTRIBUTING.md

File metadata and controls

87 lines (60 loc) · 2.35 KB

Contributing Guidelines

backstage-plugin-qeta is MIT licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on development workflow, commit message formatting, contact points, and other resources to make it easier to get your contribution accepted.

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. ❤️

Support Channels

The official support channels, for both users and contributors, are:

How to Contribute

Pull Requests (PRs) are the main and exclusive way to contribute to the project.

Local setup

Create a fork

[Fork][fork], then clone the repository:

git clone [email protected]:your_github_username/backstage-plugin-qeta.git
cd dark
git remote add upstream https://github.com/drodil/backstage-plugin-qeta.git
git fetch upstream

Install dependencies

yarn install

Run the plugins locally

A standalone development version of both the frontend and backend plugins are included in this repository. They can be started as follows:

yarn docker:up # starts postgresql
yarn dev # starts both the frontend and the backend in parallel
yarn start # starts the frontend only
yarn start-backend # starts the backend only

If you do not have docker, you can also use sqlite as database. Change the database config in app-config.yaml to

database:
  client: better-sqlite3
  connection: ':memory:'

Making Changes

Start by creating a new branch for your changes:

git checkout main
git fetch upstream
git rebase upstream/main
git checkout -b new-feature

Make your changes, then ensure that yarn lint, yarn tsc and yarn test still pass. If you're satisfied with your changes, push them to your fork.

Also remember to run database changes against a postgres instance. The instance can reside inside docker image or on local machine.

git push origin new-feature

Then use the GitHub UI to open a pull request.

Your changes are much more likely to be approved if you:

  • add tests for new functionality
  • commit messages should follow conventional commit message format
  • maintain backward compatibility
  • more information available at docs