Contributor's guide

Simple rules

1. Keep it simple
2. You may use waffle to track project
3. Take any tasks from backlog or create your own favorite feature
4. Create a wiki page for new critical features so new members can understand it well
5. Since TurboScript born to enhance JavaScript, create JavaScript friendly syntax or language features
6. Another important thing is TurboScript is about maximum speed therefore choose speed over all other things

Branching

We are using waffle to track project. waffle’ll move an issue to in progress and assign it to you if you reference it in the branch name? Just put the issue number at the end of the branch name with a # in front of it. You may use prefix like bug-fix or feature in branch name to identify the type easily.

Here are some example branch names:

bug-fix-something#123
bug-fix-something-username/repo#123  (issue in another repo)
feature-something#123

📋 ⚠️ We are not using gitFlow but if you are a big fan of it, you'll need to follow these directions.

Pull Request

If your Pull Request is related to an existing Issue on the waffle board, you can connect them together. Just say connects to #2550 or closes #2550 in the PR description. Read more»