Skip to content

Latest commit

 

History

History
63 lines (38 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

63 lines (38 loc) · 1.83 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.

Please note the Code of Conduct document, please follow it in all your interactions with this project.

Your First Code Contribution

Unsure where to begin contributing? You can start by looking through the help-wanted issues.

Getting the code

git clone https://github.com/eamodio/vscode-amethyst-theme.git

Prerequisites

Dependencies

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

yarn --frozen-lockfile

Formatting

This project uses prettier for code formatting. You can run prettier across the code by calling yarn run pretty from a terminal.

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,

Bundling

To generate a VSIX (installation package) run the following from a terminal:

yarn run pack

Debugging

Using VS Code

  1. Open the vscode-amethyst-theme folder
  2. Ensure the required dependencies are installed
  3. Choose the Launch Theme launch configuration from the launch dropdown in the Debug viewlet and press F5.

Submitting a Pull Request

Please follow all the instructions in the PR template.