We need more tests. This issue exists to clarify the testing goals of the project and give future contributors an idea of what we want to see in the test suite.
Goals:
Ensure the type bindings are mostly accurate and sound.
Reduce the likelihood for bugs, both at compile-time and at runtime.
Make sure functions are called/applied correctly.
Increase the overall quality of the library.
Keep track of breaking changes (once this library is officially stable).
Non-goals:
100% type correctness -- Node's API was designed many years ago with JS developer ergonomics in mind. Therefore, many of its functions are highly polymorphic and dynamic when it comes to types. It is not possible to perfectly model everything in Reason's type system, and we have no desire to do so.
100% API coverage -- Some things are hard to test. Some things aren't worth testing due to sheer complexity, such as isolating test code from external factors. Much of Node is focused on IO operations, which are notoriously difficult to test. We won't sweat over it. Nor should you.
Test the underlying functionality of Node -- Node has their own internally-maintained test suite that they use for development. They got it covered.
With those ideas in mind, we invite anyone and everyone to contribute to the test suite. Just submit a PR and we will be happy to integrate it if it meets our testing goals.
This is also a great way for Reason beginners to contribute to the ecosystem!
We need more tests. This issue exists to clarify the testing goals of the project and give future contributors an idea of what we want to see in the test suite.
Goals:
Non-goals:
With those ideas in mind, we invite anyone and everyone to contribute to the test suite. Just submit a PR and we will be happy to integrate it if it meets our testing goals.
This is also a great way for Reason beginners to contribute to the ecosystem!