The best repo ever :D
Well styled code is REALLY important for readability. Please adhere to the following guidelines:
- Never have more than one empty line between lines of code.
- Use empty lines to separate distinct blocks of code from one another.
- If it is not 100% clear what a method does, add a comment.
- Spaces go between pretty much everything.
- Use tabs. Never indent using spaces.
- Everything inside a block should be indented.
- Don't forget semicolons, even though they are often optional they make code more readable an less prone to mistakes.
- Close all HTML singleton tags with a /.
- Close all HTML tags.
- Order CSS properties alphabetically. The one exception is when properties are related (ie top and bottom should appear together at the bottom).
- I'm sure there are other things that should be here, so keep an eye on this page :D
Everything that goes into the main branch of this project should work perfectly. It doesn't have to be complete but it shouldn't have bugs in it.
- Create a branch for new stuff. Once you are done (what you were working on is bug free) merge it with the master branch and submit a pull request.
- Pull from this 'master' repo often. Everything works better if everyone has the most up to date code to work with.
- If something that someone else is working with is causing problems for you make an issue on GitHub.
- Check the issues on GitHub often to make sure that there is nothing there for you.
- Add descriptive commit messages. Say what you did!
This is just a list of the stuff that we are using for this project. Feel free to add to this if you find any other documentation that we should be using.
- We probably won't need this much but here is the node.js API
- Express.js API