Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 1.57 KB

CONTRIBUTING.MD

File metadata and controls

40 lines (31 loc) · 1.57 KB

Contributing

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

When contributing to this repository, please first discuss the change you wish to make via an issue.

Pull Request Process

  1. Fork the repo
  2. Clone the repo
$ git clone https://github.com/<your user name>/to-typescript.git
  1. Create a new branch for your intended changes
$ cd to-typescript
$ git checkout -b my-new-branch
  1. Make your changes
  2. Test your changes
  3. Commit your changes
  4. Open a pull request

Commit messages

Refrenced from http://chris.beams.io/posts/git-commit/, when writing commit messages for your change, use the following guidelines to do so:

  1. Separate subject from body with a blank line
  2. Limit the subject line to 50 characters
  3. Capitalize the subject line
  4. Do not end the subject line with a period
  5. Use the imperative mood in the subject line
  6. Wrap the body at 72 characters

Testing

to-typescript includes to test suites:

  • e2e tests for testing the entire extension workflow. Typically there's an e2e test for each codefix and each language being converted.
  • unit tests for testing common uitilities and services used by the other components in the extension.

Tests are run via the VS Code debug launch with the "Extension Tests" config.