close
Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (33 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

49 lines (33 loc) · 1.96 KB

Contributing to Artsy README

This project is work of many contributors.

If you work at Artsy, you're encouraged to submit pull requests, propose and discuss issues.

If you don't work at Artsy, we would love for you to ask us a question or highlight an issue in our processes, check out our Engineering blog or maybe even consider working with us. :)

Getting Started

Clone the repo and set it up with:

git clone https://github.com/artsy/README.git
cd README
yarn install

Helpful Automation

This repo has automation that:

  • Automatically generates table of contents for markdown files
  • Creates summary README.md files for each documentation section
  • Tracks missing documentation with [TODO] items in pull request comments

This automation runs on every commit to keep documentation organized and up-to-date.

How Automation Works

The automation is implemented in scripts/create-readmes.ts, which:

  • Creates a summary README.md for each section of docs
  • Provides an overview of the section in the root README.md
  • Enables running doctoc on any file with <!-- START doctoc

Each markdown file in a section uses yaml front-matter to add a description and title to the document, which are used to generate a README.md for each section.

Each section has a summary.json which describes the section for the root README.md.

Adding a new folder, or markdown file into a section will generate [TODO] items which will appear as comments in a pull request when you git push or on CI. This is implemented using Danger in dangerfile.ts.