Skip to content

Latest commit

 

History

History
87 lines (60 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

87 lines (60 loc) · 2.2 KB
Raw

Contributing to toio-spec

Environment

  • Node.js >= v8.0.0
  • Yarn

Docusaurus

toio-spec adopted Docusaurus as a website generator.

CI

<TBD>

File structure

toio-spec/
  |- .github/             # github related files (GitHub Action's script).
  |- docs/                # All technical documents are here as markdown text.
  |- website/             # is for the website and follows the way of Docusaurus.
  |
  |- .gitignore
  |- .prettierrc          # prettier configuration
  |- .textlintrc          # textlint configuration
  |- CODE_OF_CONDUCT.md
  |- CONTRIBUTING.md
  |- LICENSE              # describes license information for this repository.
  |- README.md
  |- package.json
  |- prh.yml              # Configuration file of 'textlint-rule-prh'
  `- yarn.lock

Notice

toio-spec is Japanese website and currently only have Japanese contents. Docusaurus supports multi language documents and English is default one. To serve Japanese website with Docusaurus, we put some Japanese contents under website/pages/en. We are planning to improve this with Docusaurus v2.

Development workflow

Initial setup

  1. cd <project root>
  2. yarn to install dependency
  3. cd website && yarn to install dependency for website

Build and serve website locally

To check the documents as a website, execute the following command in the website directory.

yarn start

Lint

We use TextLint for linting our documents. Please execute the following command in the project root.

yarn lint

Branch Strategy

We adopted GitHub Flow. (Only release process is customized.)

  • simple workflow
  • main branch is always stable and releasable
  • human readable branch name
  • merge main branch via PR

License

By contributing to toio-spec, you agree that your contributions will be licensed as follows:

  • CC BY 4.0 for the documents (mainly under docs/ directory)
  • CC BY-ND 4.0 for the image files (mainly under docs/assets and website/static/img)
  • MIT license for the other contributions

Please see LICENSE file for details.