Hi! 👋 Thanks for your interest in contributing to this project! If you're new, welcome ✨ and be sure to review the following guide about what's expected!
Please review our open issues tagged good first issue or help wanted. We also expect you to follow and adhere to our Code of Conduct.
To ensure the best experience getting the project going on your local machine, you'll need:
- Node.js 10+
- yarn 1.20+
- Visual Studio Code
First, start by cloning the project:
git clone https://github.com/kamranayub/pluralsight-contributing-to-open-source.git
cd pluralsight-contributing-to-open-source
Then run the yarn command to install dependencies:
yarn
After the dependencies are installed, you can run the tests to make sure the project is working as expected:
yarn test
You should be good to go!
Before submitting a PR, please be sure there's an issue existing and you've notified us in the comment thread that you'd like to work on something.
We'll respond and give you a green light. Once that's done, please open a "draft" PR as soon as you can so we can get the feedback going early before you get too far.
Please follow the existing code style. We use Prettier so you don't have to worry about formatting.