Skip to content

Latest commit

 

History

History
64 lines (41 loc) · 2.27 KB

Contributing.md

File metadata and controls

64 lines (41 loc) · 2.27 KB
Raw

Contributing

✨ Welcome, and thank you for your interest in contributing! ✨

Please note we have a code of conduct, please follow it in all your interactions with the project.

Reporting bugs or proposing features

Open a new issue for each bug or feature you want to propose.

  1. Before reporting a bug 🔍 check if it has already been reported.
  2. Specify steps to reproduce.

Pull Request Process

If you want to add new features, please make sure to discuss it in an issue.

How to contribute

  1. Clone the project
  2. Start VSCode and select Open Folder...
  3. Now select the folder of your newly cloned project. (Eg. ../vscode-language-renpy/)
If done correctly your folder view should look like this.

image

  1. Install the recommended extensions (A popup should appear). This will make sure you get the best developer experience in our workflow and it will format the code as intended.
  2. Make your changes and submit a pull request with develop as your target branch
  3. Happy coding! 🚀

Tips:

If you're working on syntax features, add the following textmate rule to your vscode settings.json file:

"editor.tokenColorCustomizations": {
   "textMateRules": [
   {
      "scope": "debug.invalid.illegal.unmatched.renpy",
      "settings": {
         "foreground": "#f00"
      }
   },
}

This will make any unmatched tokens red.

Use ctrl+alt+shift+i to display the vscode build-in token debug information.

https://regexr.com will be your new best friend.

Additional Information

Extension Versions

There are two versions: release and pre-release. Because VS Code only supports major.minor.patch and not the additional semver labels for pre-releases, to know if a version is a pre-release or final release, check its minor number:

  • major.EVEN_NUMBER.patch for final releases.
  • major.ODD_NUMBER.patch for pre-releases.