Giter Club home page Giter Club logo

standards-starter's Introduction

Standards Starter

Standards Starter is intended to function as a boilerplate repository to help your company/organization quickly implement standards used by your entire team.

The standards and document structure presented here were adapted from the Human Made Engineering Handbook. As such, this project is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Contributing

Have a good idea? Find one of my (I assume many) typos? Great! Create an issue or fork this repo and send a pull request.

How to Use

It's important to note that while the default standards are mostly concerned with PHP, JavaScript, and HTML/CSS, the goal of this project is to be flexible enough to fit any project type or technology stack.

To that end, you'll notice that certain sections (Ex: File Structure) only contain placeholder documents. These documents should be written to fit your company or organization's own practices.

Getting Started

Fork this repository and modify it to fit your own needs.

Introduction

To ensure everyone’s able to work effectively and efficiently, we enforce a number of standards across our code. Some of these are for performance and security in high-traffic, high-impact sites, while some enable us to collaborate more effectively.

While projects can deviate from these standards (and we encourage experimenting with new standards), projects tend to follow the majority of these rules and guidelines.

Directory

File Structure

How to structure projects at the file level.

Documentation

Code should be commented thoroughly, and here’s how to do it.

Privacy

Guidelines on (meeting) privacy requirements.

Performance

Considerations on algorithmic complexity and performance.

Best Practices

How and when to utilize best practices.

Frontend

Frontend-specific standards.

Backend

Backend-specific standards.

Style Guides

Various style guides for the different technologies we use.

standards-starter's People

Contributors

mattsparks avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

radosslav

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.