Skip to content

Latest commit

 

History

History
56 lines (33 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

56 lines (33 loc) · 2.21 KB

Contributing

First off all, thank you 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.

Your First Code Contribution

Unsure where to begin contributing? You can start by looking through the good first issue issues.

Getting the code

git clone https://github.com/alefragnani/vscode-pascal-formatter.git

Prerequisites

Dependencies

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

git submodule init
git submodule update
npm install

Build / Watch

From inside VS Code, run Tasks: Run Task Build. It Builds the extension in Watch Mode.

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

Tip! You can press Cmd+Shift+B (Ctrl+Shift+B on Windows, Linux) to start the watch task.

Tip! You don't need to stop and restart the development version of Code after each change. You can just execute Reload Window from the command palette.

Linting

This project uses ESLint for code linting. You can run ESLint across the code by calling npm run lint from a terminal. 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

  1. Open the vscode-pascal-formatter folder
  2. Ensure the required dependencies are installed
  3. Choose the Launch Extension launch configuration from the launch dropdown in the Run and Debug viewlet and press F5.

Submitting a Pull Request

Be sure your branch is up to date (relative to master) and submit your PR. Also add reference to the issue the PR refers to.