docs: improve contribution guideline

[0x6b]

As part of recent documentation enhancement efforts (#434, #466, #468, #470, #471), I would like to improve contribution guideline, mainly try to document my understanding from trial–and–error and great assistance from @azu. I'd like to hear from folks around here before putting any effort into these changes as it will take some time to write.

My proposals are:

1. Merge part of README and Contributing Guideline
2. Split into main document How to Contribute and supporting documents Coding Guidelines + Code Organization
3. Add these three to Contributing section of the side bar at new documentation site
4. Simplify README

New documents could (but not limited to) have following TOCs. Appreciate any comments. Thanks!

---

How to Contribute

Reporting New Issues or Feature Suggestions

Create an issue first

• Modify Existing Document
• Add New Document
• Fix Known Issues or Implement New Feature
  • Good First Issue

Development Workflow

Installing Prerequisites

• Git
• Node.js 4.0.0+
• npm 2.0.0+
• yarn 1.3.2+

Cloning Copy of textlint

• Folk textlint repo

• Clone locally

    git clone ...
  

Creating Branch for Your Work

git checkout -b ...

Building Codebase

yarn
yarn bootstrap
yarn build
yarn build:website

Making Changes

Don't forget to add a test and document!

Running Tests

• For Code Changes:
  • While Developing
    • Package Level Test
  • Before Push
    • Unit Test
    • Examples Test
    • Integration Test
    • All
• For Documentation Changes:
  • While Developing and Before Push
    • Documentation Test

Committing the Changes

Pushing the Commit and Opening a Pull Request

Working with Reviews (if any)

• Push additional commits
• Pull upstream
• Rebase

Merge!

---

Coding Guidelines

Code Linting

Style

Commit Message Format

Semantic Versioning

---

Code Organization

textlint architecture

kernel/rule/filter/preset/plugin/formatter/fixer/etc... (will need help from @azu)

Monorepo with Lerna

Core Packages

Rule and Plugin Helpers

Related GitHub Organizations and Repositories

[azu]

Thanks for nice proposal.
It looks good for me.

📝 memo
textlint has long long README.
It is expected result.( It is inspired by power-assert.)

Because, almost user does’t look into link.
Flat README is useful for describing the overview.
But, we will get documet site in recenty.
Reafactoring existing documents is reasonable.

[0x6b]

@azu, thank you. I will work on this.

I think documents need some redundancy/repetition to clearly deliver message to users so long README is ok for me as well. Let me try.