Skip to content
Standardized FLYWHEEL Way
Python HTML Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows Use pullreminders/slack-action@v1.0.7 Dec 6, 2019
bin Remove `bin/update` script and update docs accordingly Dec 6, 2019
config Let shell source a script file in this repository Dec 5, 2019
docs
public
.editorconfig
.gitignore
Brewfile.macos
README.md Remove `bin/update` script and update docs accordingly Dec 6, 2019
package.json Update README.md Nov 18, 2019
yarn.lock

README.md

FLYWHEEL Standard

flywheel-standard

An experimental repository of documents describing the standardized FLYWHEEL way.

  • The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.
  • In the event of a contradiction between ongoing way and the standard way, the ongoing one MAY take precedence over the documentation. However, all developers, repositories, and any other things related to our DX SHOULD make an effort to keep following the standard.
  • All documents MUST be considered as living.

Setup

To set up a new machine, first clone this repository and then run the included bin/setup:

bin/setup

When you notice that the origin/master is updated, run bin/setup again at the edge commit.

Badge

Show your repository is following the flywheel-standardflywheel-standard

[![flywheel-standard](https://img.shields.io/badge/FLYWHEEL-Standard-171b61.svg?style=flat-square)](https://github.com/flywheel-jp/flywheel-standard)

Preview documents

Run the local server with yarn start. This command automatically open docs in default browser. To disable this behavior you may use --no-open option:

yarn start
# yarn start --no-open

Deployment

Every push to master branch will upload documents to the Mouseion. Deploys happen automatically.

You can’t perform that action at this time.