https://github.com/bu-ist/coding-standards

Code style guides for web projects at Boston University.
https://github.com/bu-ist/coding-standards

coding-standards css php sass wordpress

Last synced: 2 days ago
JSON representation

Code style guides for web projects at Boston University.

• Host: GitHub
• URL: https://github.com/bu-ist/coding-standards
• Owner: bu-ist
• Created: 2014-10-08T17:03:31.000Z (about 10 years ago)
• Default Branch: main
• Last Pushed: 2024-09-13T19:45:05.000Z (2 months ago)
• Last Synced: 2024-10-21T01:37:56.466Z (25 days ago)
• Topics: coding-standards, css, php, sass, wordpress
• Language: Ruby
• Size: 252 KB
• Stars: 10
• Watchers: 33
• Forks: 5
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# BU Coding Standards

The purpose of this repository is to establish baseline standards for developing web projects at Boston University.

New web team employees should review these documents prior to committing any code to our code base.

## Guides

* [WordPress](wordpress/README.md)

* [CSS and Sass](css-and-sass/README.md)

* [PHPbin](phpbin/README.md)

* [Git/Best Practices](best-practices/README.md)

## Why?

> *Be consistent.*

>

> The point of having style guidelines is to have a common vocabulary of coding so people can concentrate on what you’re saying rather than on how you’re saying it. We present global style rules here so people know the vocabulary, but local style is also important. If code you add to a file looks drastically different from the existing code around it, it throws readers out of their rhythm when they go to read it. Avoid this.

>

> If you’re editing code, take a few minutes to look at the code around you and determine its style. If they use spaces around all their arithmetic operators, you should too. If their comments have little boxes of hash marks around them, make your comments have little boxes of hash marks around them too.

"Parting Words", [Google style guide](http://google-styleguide.googlecode.com/svn/trunk/htmlcssguide.xml)

## Enforcement

Coding standards are only useful if they are followed.

Currently we have no tooling in place to enforce these standards. While an automated process that reviewed commits for coding style and reported violations is possible, we're not quite there yet.

In the meantime there are several tools that can be installed locally to ensure you're writing code that conforms with these standards. Language-specific tools will be documented within their respsective guides.

## Contributing

Have a recommendation? Create a branch and submit a pull request!

[Github pull requests](https://help.github.com/articles/using-pull-requests/) are well-suited for this; opening a pull request creates a dedicated page for comments, and notifies all repostiory watchers.