Skip to content
This repository has been archived by the owner on Aug 29, 2023. It is now read-only.

Latest commit

 

History

History
118 lines (83 loc) · 4.62 KB

CONTRIBUTING.md

File metadata and controls

118 lines (83 loc) · 4.62 KB
Raw

Welcome to Sort 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.

Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly.

New contributor guide

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

Issues

Create a new issue

If you spot a problem, search if an issue already exists. If a related issue doesn't exist, please open a new one.

Security

If you believe you have found a security vulnerability, we encourage you to responsibly disclose this and not open a public issue. We will investigate all legitimate reports. Email [email protected] to disclose any security vulnerabilities.

Solve an issue

Scan through our existing issues to find one that interests you. 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.

Make Changes

  1. Fork the repository. - Using GitHub Desktop: - Getting started with GitHub Desktop will guide you through setting up Desktop. - Once Desktop is set up, you can use it to fork the repo!
  • Using the command line: - Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.

  1. Install or update to Node.js, at the version specified in the .nvm file. If you are using nvm, it can help make this step easier.

  2. Create a working branch and start with your changes!

Test your change

Test your changes before committing them.

Run a local build
npm run build
Link the package
# do this in this repo
npm run link
Link the package in your project
# do this in your project
npm run link @sort/react-components

Prepare for release

If everything works as expected, go ahead and make the commit.

How to write commits

We use conventional commits, if you're not familiar with it, please take a look as it will determine the type of release that is created.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR. - Please link the PR to an 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 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. - As you update your PR and apply changes, mark each conversation as resolved.

  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 You are now part of the Sort development community. The Sort team thanks you ✨.