Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add contributing guidelines #87

Merged
merged 1 commit into from
May 19, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Welcome to the Blink Labs contributing guide <!-- omit in toc -->

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

Read our [Code of Conduct](./CODE_OF_CONDUCT.md) 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](README.md). Here are some
resources to help you get started with open source contributions:

- [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)

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

- [CODEOWNERS](CODEOWNERS)

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.

<br>

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](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
if you are solving one.
- Enable the checkbox to
[allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork)
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](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request)
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.