Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

63 lines (45 loc) · 2.56 KB
Raw

Welcome to the Blink Labs contributing guide

Thank you for investing your time in contributing to our project!

Read our Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Getting started

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Blink Labs repositories use Conventional Commits for all commits. This defines a standard format for commit messages across repositories and projects.

Blink Labs repositories use CODEOWNERS files to provide information on who should review a contribution. For repositories with regular outside contributors, they will be listed within this file in the repository or repositories which they maintain.


Contributions to open source come in many forms. You can contribute to Blink Labs projects in several ways.

Issues

Create a new issue

If you spot a problem with a project, search if an issue already exists. If a related issue doesn't exist, you can open a new issue in the repository.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.