You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
38 lines
1.3 KiB
38 lines
1.3 KiB
2 years ago
|
# Contributing (v3)
|
||
|
|
|
||
|
|
Thanks for being part of the code!
|
||
|
|
|
||
|
|
## Directory layout
|
||
|
|
|
||
|
|
```css
|
||
|
|
+---.github
|
||
|
|
¦ +---workflows /* CI & automations for PR and releases */
|
||
|
|
+---.vscode /* VSCode Debug and tasks file */
|
||
|
|
+---node_modules /* Node.js modules, for npm i */
|
||
|
|
+---src
|
||
|
|
¦ +---client
|
||
|
|
¦ +---data /* The data file that can be used for your views, containing useful strings */
|
||
|
|
¦ +---managers
|
||
|
|
¦ +---rest /* HTTP Requests */
|
||
|
|
¦ +---structures
|
||
|
|
¦ +---util /* Client options and private constructor strings */
|
||
|
|
+---typings /* TypeScript auto-generated typings for VSCode and other IDE using TS */
|
||
|
|
+---test /* Mocha tests (coming later in v3) */
|
||
|
|
```
|
||
|
|
|
||
|
|
## Pull Requests
|
||
|
|
|
||
|
|
Before opening a PR, run `npm test` to do a eslint scan then run mocha tests
|
||
|
|
|
||
|
|
Before commiting, **be sure that no files from the `typings/` directory is commited!** GitHub Actions will build it automatically after pushing
|
||
|
|
|
||
|
|
When opening a PR, please open it to the 'develop' branch. Thanks!
|
||
|
|
|
||
|
|
## Issues
|
||
|
|
|
||
|
|
All issues are appreciated, it can be suggestions, bug fixes.
|
||
|
|
|
||
|
|
## Discussion
|
||
|
|
|
||
|
|
If you want to talk about this project or just for saying hi, Join the [Greep's Discord Server](https://greep.gq/discord) in the #node-tmio channel or the [Openplanet Discord Server](https://openplanet.nl/link/discord), in the #trackmania-io channel
|