Contribution Guide

This contribution guide basically expose what should be follow if contribution is desired(Which is highly appreciated). Must of the things here you already know, others may be new, and other of great help related with this project or any other open source project. Please go through it, it will make you a better software engineer.

Coding

• First, follow the best practice guide. Follow each advice as your religion.
• If you don't know very well Javascript or find hard to understand all the asynchronous programming stuff, we have good news! Asynchronous programming is the future, start by learning good Javascript coding in the You Don't Know Javascript series(available for free)
• We use(vaguely) the Google Javascript Styling Guide. Please follow this guide. The code may be a bit messy but we will continue working on it, refactoring for simplicity and cleaness is welcome.

Forks and Pull requests

We highly encourage Forks and Pull requests. The main purpose of Trueno is to serve as a simple, fast, and easty to develop Graph Store/Database solution for the community. Please feel free to develope and contribute. If you wan't to join the project please communicate with us.

Bugs, fixes, new features

We intent to keep working on Trueno as it grows. But keep in mind that by the time this guide is being written, we are a very busy group of students. Please feel free to join the project and contribute.

Database fundamentals and basic knowledge.

It will be useful to read a bit of Database principles before develop new features or apply fixes. Here are some resources which can be useful:

• DATABASES: SELF-PACED(Stanford Online Courses)
• Free Self-Paced Courses(from DataStax)
• Graph Databases for Beginners: ACID vs. BASE Explained(Neo4J)

Graphs

• We recommend A First Course in Graph Theory by Gary Chartrand and Ping Zhang. It is a great start to get into the world of graphs.
• Giving a look at NetworkX can be very useful.