Standards

Project health

Table of Contents

• Overview
• Common definitions
  • Project Names (Recommendation)
  • Documentation
  • Cover Tests
  • CI
  • Versioning
  • Internationalization
  • Images
  • Allow Data Manipulation
• Definitions by stack
  • NodeJS/Javascript
  • Go
  • Java
  • Operators
• Scripts
  • Applying .github file changes to organization repositories
  • Getting all repositories to use in the above script

Overview

The purpose of this repository is to centralize all standards that must be applied to AeroGear projects.

Common definitions

Project Names (Recommendation)

• The name of the projects in this organization should follow the standard aerogear-<project-name>.

Documentation

• .adoc - (Format for the docs in the repo)

• swagger.io

Cover Tests

• Coveralls.io

• Codecov.io

CI

• Shields.io - For customizations

• Circleci

• Jenkins

Versioning

• Semantic Versioning 2.0.0

Internationalization

• Zanata

Images

• quay.io

Allow Data Manipulation

• GraphQL

• Rest API

Definitions by stack

NodeJS/Javascript

• JavaScript Standard Style

• Npm-run-script

• Semver npm

• Expressjs

• Yargs

• MochaJS

Go

• testing

❗	Do not use other lib as for example assert

• echo web framework

Java

← TODO →

Operators

• operator-sdk

• Golang type/language

• kubernetes/client-go

• kubernetes API

Scripts

Applying .github file changes to organization repositories

Standards in this repository can be applied to all organization repositories. To update standards in AeroGear organization please follow steps bellow:

• Review apply.js script with repositories that you want to update. Check the constant reposToClone value to see what repositories we should use to apply the changes.

• Execute following commands

npm i
npm run apply

Getting all repositories to use in the above script

• Execute following commands

npm i
npm run getAll

• Check the file allRepos.txt created in the root directory of this project. This data can be used in the above command.

ℹ️	This code implementation is using the octokit

💡	See here the GitHub API documentation