vkeyboardv / standards

Standardized guidelines for technical members of Selectra.

Home Page:https://github.com/Selectra-Dev/standards

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Selectra's standards

Standardized guidelines for technical members of Selectra.

This documentation follows the RFC 2119 specification (it describes keywords like MUST or MUST NOT).

Table of contents

  1. Description

  2. Contributing

    2.1. Programming

    2.2. Management

    2.3. Miscellaneous

  3. Contributing

  4. Support

Description

This repository contains Selectra's standards every technical member MUST follow when designing, developing and maintaining company's products.

Such standardization is necessary to conduct successful teamwork and deliver high quality software by ensuring consistency across all of them.

Contents

This documentation is separated into three main areas that covers respectively Programming, Operations and Management.

There is also auxiliary Miscellaneous document, that is suitable for general subjects.

Programming

Selectra develops and maintains mainly PHP, Ruby and JavaScript applications.

Often they are supplemented with other languages/technologies like HTML and CSS and SQL.

All of those languages/technologies have separate file that contains its standards.

Operations

Operations (called also DevOps) are key area of our company.

Its most important part is Docker.

Management

Management and software maintenance is challenging process and requires unified approach.

The most important aspects of management are GitHub and Design.

Miscellaneous

Various standardization not suitable for either Programming or Management.

Contributing

Such standardization aims to satisfy all the technical members.

Any concerns, misunderstandings and arguments have to be discussed through GitHub Issues supplemented by provided issue templates.

If one problem was raised more than once, or has two completely different opinions, it deserves to be mentioned in this document.

Once discussed, please create a new pull request using provided pull request templates.

Support

This document is a collective work of all the technical members of Selectra.

About

Standardized guidelines for technical members of Selectra.

https://github.com/Selectra-Dev/standards