search

ev-devs / ElectronPOS

A point of sale system written on top of Electron.
2 stars 0 forks source link

Headers for the files #2

Closed ChannelJuanNews closed 8 years ago

ChannelJuanNews commented 8 years ago

So I think the project is starting to get large enough that I start losing track of files. I fear that future contributors will be just as lost if not more since they might not be familiar with our project structure. As a solution, we are going to start putting headers on all the files so we know what every file does and what it's purpose is. For now, I am going to start putting the header below on all files, but its not completely set in stone.

/* 

tl;dr THIS CONTAINS ALL THE LOGIC NEEDED TO MANIPULATE THE GUI FOR THE pos view

file name   : pos.js
full path   : app/views/POS/pos.js
purpose     : manipulate the POS GUI when scanning items
              as well as communication with the EMV reader (to charge client)
present in  : pos.html

*/

if you want more information to be put into the headers then please go ahead and suggest them so we may integrate them into all the files!

ColdNightHour commented 8 years ago

Barely saw this, really like it. Will add headers now.

ChannelJuanNews commented 8 years ago

lit af