Contributing

We welcome submission of algorithms and high quality code on all topics concerning quantitative economics.

Less experienced developers who wish to get involved can help improve documentation, contribute notebooks or work on smaller enhancements.

A good place to start is by visiting the project issue tracker.

If you are new to open source development please consider reading this page first.

General Information

As a programming language, Julia is still new and thus some aspects of the language are still evolving as it matures. As a result there may be some changes from time to time in styles and conventions. The upside is that it is fast and quickly being adopted by the broader scientific computing community.

The Julia style guide is a good starting point for some Julia programming conventions.

Writing Tests

One prerequisite for contributions to QuantEcon is that all functions and methods should be paired with tests verifying that they are functioning correctly. This type of unit testing is almost universal across a quality software projects. A guide to writing tests in Julia is currently in work.