Skip to content

Latest commit

 

History

History
100 lines (57 loc) · 3.31 KB

CONTRIBUTING.md

File metadata and controls

100 lines (57 loc) · 3.31 KB
Raw

Contributing Guide

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on skateshop ✨.

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.

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:

Getting started

Fork the repository

Fork the project on GitHub

Clone the project

Clone your fork locally. Do not clone the original repository unless you plan to become a long-term contributor and have been given permission to do so.

git clone https://github.com/sadmann7/skateshop
cd skateshop

Install dependencies

Install the project dependencies:

pnpm install

Create a branch

Create and check out your feature branch:

git checkout -b my-new-feature

Make changes locally

Make your changes to the codebase. See the development guide for more information.

Commit your changes

Commit your changes:

git commit -m 'Add some feature'

Push your changes

Push your changes to your fork:

git push -u origin my-new-feature

Create a pull request

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

  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.

Issues

Create a new issue

If you spot a problem in the codebase that you believe needs to be fixed, or you have an idea for a new feature, take a look at the Issues.

If you can't find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels and projects to find issues that need attention.

Then, fork the repository, create a branch, and make your changes.

Finally, open a pull request with the changes.

Your PR is merged

Congratulations 🎉🎉 The GitHub team thanks you ✨.

Once your PR is merged, your contributions will be publicly visible on the skateshop.

Credits

This Contributing Guide is adapted from GitHub docs contributing guide.