Skip to content

Latest commit

 

History

History
57 lines (35 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

57 lines (35 loc) · 1.75 KB
Raw

Contributing to my package

Welcome, and thank you for your interest in contributing to vscode-vash!

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Contribution Guidelines

There are a couple of ways you can contribute to this repo:

  • Ideas, feature requests and bugs: We are open to all ideas and we want to get rid of bugs! Use the Issues section to either report a new issue, provide your ideas or contribute to existing threads.
  • Documentation: Found a typo or strangely worded sentences? Submit a PR!
  • Code: Contribute bug fixes, features or design changes.

Creating an Issue

Before you create a new Issue:

  • Check the Issues on Github to ensure one doesn't already exist.
  • Clearly describe the issue, including the steps to reproduce the issue.

Making Changes

Getting Started

  • Install Node.js.
  • Fork the project and clone the fork repo. (how to create fork?).
  • Create a topic branch from the master branch.
  • Run yarn or npm install to install the application dependencies.

Setup

  1. Start watching:
$ npm run watch
  1. Make changes:
$ code .
  1. Run tests:
$ npm t
  1. Test your version of the extension:

Press F5 in the editor and then test extension commands and functions.

Commit

Keep git commit messages clear and appropriate. You can use Angular guide.