|
|
@@ -1,17 +1,18 @@
|
|
|
+####Contributing to Gravity
|
|
|
Everyone is welcome to contribute to Gravity. Contributing doesn’t just mean submitting pull requests,
|
|
|
there are many different ways for you to get involved, including reporting bugs, add new functionalities
|
|
|
or just participating in the project.
|
|
|
|
|
|
-##Where to make changes
|
|
|
+####Where to make changes
|
|
|
Core libraries and documentation is probably the areas that need major contribution.
|
|
|
Any change to the core VM or other parts of the compiler are welcomed.
|
|
|
|
|
|
-##Code style and syntax rules
|
|
|
+####Code style and syntax rules
|
|
|
Looking at the Gravity source code I think you can easely follow the same coding style and syntax rule.
|
|
|
Private functions usually don't begin with a gravity_ prefix and are marked as static.
|
|
|
Feel free to expand this section with a more formal description of the syntax rules.
|
|
|
|
|
|
-##Testing rules
|
|
|
+####Testing rules
|
|
|
If you fix a bug or if you add a new functionality then a unit-test is required.
|
|
|
A unit-test is a single source code file that is able to run under the unittest executable file.
|
|
|
You are free to test your functionalities/fixes into a single unit-test file or split the test in more files.
|
Marco Bambini