Coding Conventions / Workflows

[Chovin]

Why

When working on a collaborative project, deciding on the workflow and code conventions (code's format/style/general structure) will..

benefit code maintainability between contributors, and it will increase our productivity during collaboration.

Sticking with the most common conventions and workflows in the field will also teach us how to better interact and contribute to the open source community and in our workplaces.

What

As per conversation on 10/19, for this project we will be using*:

- HTML/CSS/JS for our main codebase

• Bootstrap for responsive design
• Sass and precompilers are up for discussion
• Backend language is not decided

  - Git/GitHub as our version control / collaboration solution

• A local GUI is recommended

  - ZenHub/GitHub as our workflow manager / issue(task) tracker

• If you do not have ZenHub, please install it. It should be free on Chrome and it integrates with GitHub's GUI quite nicely

  - GitHub Pages/Jekyll as our hosting platform at least for the interim

• If you do not know what Jekyll is, don't worry about it.. yet. If you do know what it is, please let us know... and teach us. We've already encountered problems with it.

*Other solutions are very welcome. Please leave a comment below if you would like to propose different solutions or if you have any questions.

---

Later

It may be appropriate to consolidate this epic into a doc in our each of our project repos eventually. I believe it is a convention among open source projects to have a CONTRIBUTIONS.md explaining a project's conventions and contribution guidelines

[Chovin]

Atlassian's BitBucket provides free licences for educational purposes. possible solution for future?