Skip to content

Latest commit

 

History

History
72 lines (43 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

72 lines (43 loc) · 2.3 KB
Raw

Contributing

🚀 First off, thanks for taking the time to contribute! 🚀

When contributing to this project, please first discuss the changes you wish to make via an issue before making changes.

Getting the code

You can fork from the repo below or directly clone it using this command in the terminal:

git clone https://github.com/oslabs-beta/GatsbyHub.git

Prerequisites

Dependencies

From a terminal, where you have cloned the repository, execute the following command to install the required dependencies:

npm install

Watch

During development you can use a watcher to make builds on changes quick and easy. From a terminal, where you have cloned the repository, execute the following command:

npm run watch

Or use the provided watch task in VS Code, execute the following from the command palette (be sure there is no > at the start):

task watch

This will first do an initial full build and then watch for file changes, compiling those changes incrementally, enabling a fast, iterative coding experience.

Formatting

This project uses prettier for code formatting.

To format the code as you make changes you can install the Prettier - Code formatter extension.

Add the following to your User Settings to run prettier:

"editor.formatOnSave": true,

Linting

This project uses ESLint for code linting TypeScript using the AirBnB Style Guide. Warnings from ESLint show up in the Errors and Warnings quick box and you can navigate to them from inside VS Code.

To lint the code as you make changes you can install the ESLint extension.

Debugging

Using VS Code

  1. Ensure the required dependencies are installed
  2. Start the watch task
  3. Choose the Launch GatsbyHub launch configuration from the launch dropdown in the Debug viewlet and press F5.

Submitting a Pull Request

Please follow all instructions in the PR template.