Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

43 lines (27 loc) · 1.19 KB
Raw

Contributing Guidelines 🚧

First of all, thanks for your interest in contributing to this project 😀

Installation 👷‍♂️

You need to install NodeJS and Yarn, you can also use NPM instead of Yarn as your package manager

Clone the project

git clone https://github.com/marcelogaldino/space.git

# Go to the project directory
cd space/

Install dependencies

# installing dependencies
yarn

#running the project
yarn start

Now you are ready 🚀

Bugs 🐛

It would be very nice if you find and report bugs, but, be sure to include:

  • Package version
  • Node version
  • Brief but thorough description of the issue
  • Link to a CodeSandbox or similar (optional, but highly recommended, especially for complex problems)

If you have an idea for an enhancement, go ahead and share it via an issue

Commits and Code Standardization

This project follow the Conventinal Commits specification. Husky execute scrips according to git hooks in order to test if a developer is following the commits convention. Check out this project for more.