Table of Contents
Welcome to Juliar Project
I would like to thank you for contributing to the Juliar.Future Project. The aim of this project is to build a fully functional compiler for Juliar Programming language that will compile for use in Java Environments.
Here are some helpful guidelines for contributing:
The Juliar Communtiy
Have an idea or a big feature. Please make sure to post it in issues tab on [https://github.com/juliarLang] . For huge updates, make sure you talk to an administrator responsible for Juliar repository before implementing it. The feature you might be working in already exists or is planned. For smaller updates, feel free to fork the repo, do the changes, and submit pull requests.
Bug fixes are always welcomed and are encouraged. If you do not know how to fix a bug, please make sure to post it in slack chat.
You can also post it in the issues tab on [https://github.com/juliarLang]
Please follow the coding outlined at https://google.github.io/styleguide/javaguide.html
Compiling with an IntelliJ IDEA
We use IntelliJ IDEA in order to have a nice environment to build the project. We use Gradle wrapper to manage all the dependencies of the project.
Follow the steps below to setup the IntelliJ environment for development of JuliarFuture.
If you have problems compiling, make sure Java is defined in Project settings.
Anybody is free to fix the documentation. The Documentation is one of the harder part of the project. It's hard to write it and it's even harder to maintain. If you can help with that, it will be greatly appreciated Make sure to post any big changes on the forums to get some feedback.
Most of the testing will be automated. However, there is no substitute for a human being. The testing is probably harder than coding. Writing a test is always welcomed. Make sure to focus on edge cases when you write a test.
Coding & Submitting to Github
Keep the code clean by following K.I.S.S. principle. If you want to make a major change, just fork the project, update it, and once you've fully implemented the fix, submit a pull request to the main project.
Thank you for contributing. Your contribution is very important!