Contributing

Firstly, thank you for considering contributing to Zeplin Visual Studio Code Extension. ✌️

We welcome any type of contribution, not only code. You can help by:

Issue Tracking

We use GitHub issues to track public bugs, feature requests and suggestions. Open a new issue.

☝️ Please review your bug reports before posting to remove or mask any private/sensitive information.

For each bug report, try to include the following information:

A quick summary and/or background
What you expected would happen
What actually happens
Steps to reproduce
- Share sample text output/screenshot/screencastcast if possible
- Share configuration file and/or log file
  - (Mask any private/sensitive information)
  - (Save the logs file via Save Logs command)

Prerequisites: Git, Node.js, npm

Clone repository
In the repository directory, run npm install to install dependencies
Start debugging in Visual Studio Code, default shortcut is F5
- To avoid restarting every time the code changes, you can:
  1. Run watcher (npm run watch or “Command/Ctrl + Shift + B”) to recompile automatically when the code changes
  2. Run the “Developer: Reload Window” command in the Visual Studio Code debug instance

We use GitHub Flow, all code changes happen through pull requests.

Fork the repo and create a branch from master
Read Technical Overview and follow its principles
If you've changed APIs, update the documentation
Make sure your code lints by running npm run lint
- We use ESLint, husky is configured to run npm run lint as a pre-commit hook for convenience
Open a pull request

By contributing, you agree that your contributions will be licensed under its MIT License.

This document was adapted from an open source contribution document gist shared by braindk.