-
Notifications
You must be signed in to change notification settings - Fork 332
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Contributing to ChaiScript | ||
|
||
Thank you for contributing! | ||
|
||
# Pull Requests | ||
|
||
Please follow the existing style in the code you are patching. | ||
|
||
- two space indent | ||
- no tabs EVER | ||
- match the existing indentation level | ||
|
||
All ChaiScript commits are run through a large set of builds and analysis on all supported platforms. Those results are posted on the | ||
[build dashboard](http://chaiscript.com/ChaiScript-BuildResults/index.html). No PR will be accepted until all tests pass. | ||
|
||
The build system has full integration with GitHub and you will be notified automatically if all tests have passed. | ||
|
||
# Issues | ||
|
||
Please do not post a "chaiscript is too slow", "chaiscript compiles too slowly", or "chaiscript needs more documentation" issue | ||
without first reading the following notes. | ||
|
||
## ChaiScript is Too Slow | ||
|
||
We are actively working on constently improving the runtime performance of ChaiScript. With the performance being | ||
[monitored with each commit](http://chaiscript.com/ChaiScript-BuildResults/performance.html). | ||
|
||
If you feel you *must* post an issue about performance, please post a complete example that illustrates the exact case you | ||
feel should be better optimized. | ||
|
||
Any issue request regarding performance without a complete example of the issue experienced will be closed. | ||
|
||
## ChaiScript Compiles Too Slowly | ||
|
||
This is also something we are actively working on. If you need highly optimized build times, please see [this discussion | ||
on the discourse site](http://discourse.chaiscript.com/t/slow-build-times/94). | ||
|
||
## ChaiScript Needs More Documentation | ||
|
||
If you have a question that is not addressed in the [cheatsheet](https://github.com/ChaiScript/ChaiScript/blob/develop/cheatsheet.md) | ||
please open an issue so we can get the Cheatsheet updated. |
abc30ba
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
abc30ba
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
develop (lefticus) - i386-Windows-10-VisualStudio-14: OK (389 of 389 tests passed, 0 test warnings)
abc30ba
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
develop (lefticus) - Win64-Windows-10-VisualStudio-14: OK (389 of 389 tests passed, 0 test warnings)
abc30ba
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
develop (lefticus) - i386-Windows-10-VisualStudio-12: OK (388 of 389 tests passed, 0 test warnings)
abc30ba
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
develop (lefticus) - Win64-Windows-10-VisualStudio-12: OK (388 of 389 tests passed, 0 test warnings)
abc30ba
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
develop (lefticus) - x86_64-Linux-Ubuntu-14.04-clang-3.5: OK (397 of 397 tests passed, 0 test warnings)
abc30ba
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
develop (lefticus) - x86_64-Linux-Ubuntu-14.04-clang-3.5-LibC++: OK (389 of 389 tests passed, 0 test warnings)
abc30ba
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
develop (lefticus) - x86_64-Linux-Ubuntu-14.04-clang-3.6-AddressSanitizer: OK (3047 of 3047 tests passed, 0 test warnings)
abc30ba
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
develop (lefticus) - x86_64-Linux-Ubuntu-14.04-clang-3.6-ThreadSanitizer: OK (389 of 389 tests passed, 0 test warnings)
abc30ba
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
develop (lefticus) - x86_64-Linux-Ubuntu-14.04-gcc-4.8-NoThreads: OK (393 of 396 tests passed, 0 test warnings)
abc30ba
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
develop (lefticus) - x86_64-Linux-Ubuntu-14.04-gcc-4.8: OK (397 of 397 tests passed, 0 test warnings)
abc30ba
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
develop (lefticus) - x86_64-Linux-Ubuntu-14.04-gcc-4.6: OK (397 of 397 tests passed, 0 test warnings)
abc30ba
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
develop (lefticus) - x86_64-Linux-Ubuntu-14.04-cppcheck-1.61: OK (0 of 0 tests passed, 0 test warnings)
abc30ba
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
develop (lefticus) - x86_64-Linux-Ubuntu-14.04-custom_check: OK (0 of 0 tests passed, 0 test warnings)