OpenTechStrategies / lisc-ttm

LISC TTM code. See https://ttm.lisc-chicago.org/.
GNU Affero General Public License v3.0
1 stars 4 forks source link

Coding Standards #84

Open akshayagarwal opened 9 years ago

akshayagarwal commented 9 years ago

We should adapt a standard coding standard which will enforce the guidelines for things like file names , code-formatting, directory structure etc.

PHP officially advises the use of PSR standards. Most open source frameworks adhere to this. Other developers who would adopt this codebase after it goes open source would look for these standards in the code so they feel at home

http://www.php-fig.org/psr/psr-1/ http://www.php-fig.org/psr/psr-2/

kfogel commented 9 years ago

+1. Cecilia, let's go over these pages tomorrow -- I can explain any abbreviations or jargon that are unfamiliar (or most of it, anyway, hopefully).

I didn't know about these standards. But since they exist, let's try to adhere to them; that way the code base will be easier for other programmers to work on.

One thing we'll need to do is estimate the amount of legacy work making the existing code obey these standards, though. Mmmmm... that might be a lot.