1.7 KiB
1.7 KiB
A350-family Contributing Guidelines
These examples will show the Guidelines for contributing. Please follow this at all times, or your contribution will not be merged.
Basic Guidelines:
- Use Tabs to indent code, DO NOT USE SPACE.
- Use lowerCamelCase or underscores for naming Nasal variables/functions (someFunction, some_function).
- Comments optional for XML, mandatory for Nasal.
- Do not add a comment to every line, only to functions/groups of code.
- Remove .bak or .blend files, unless absolutely needed.
- Always pull with
git pull --rebase
to avoid unneccesary merge commits. - Always use descriptive commit messages
- Test before commiting.
Formatting Guidelines:
For new files adhere to the following, for existing files, maintain the used formatting.
Indenting and Line Breaks:
<!-- XML -->
<something>
<something-else>0</something-else>
<something-more>
<more-stuff></more-stuff>
</something-more>
</something>
# Nasal
var something = func
{
somethingElse();
}
Brackets, Spaces, Commas, Semi-Colons, and Parentheses:
var something = 0;
var someOtherThing = func
{
if (something == 1)
{
something = 0;
}
else
{
something = 1;
}
settimer(func
{
setprop("something", something);
}, 5);
}
Forks, Branches, and Merging
Please fork the repository, and commit your changes there. Branches are optional. When you are ready for us to look over you work, submit a pull request, following our pull request template, and a main Developer will look over it. If there is an issue that needs to be resolved before merging, the Developer will leave a comment on the pull request.
Liveries
All liveries except for the house and launch customer livery belong into the the livery repo.