From b227c8cef44e18180385ef3b2c6f1113b85ca9a1 Mon Sep 17 00:00:00 2001 From: Pranshu Chittora Date: Tue, 30 Apr 2019 23:49:19 +0530 Subject: [PATCH 1/2] chore(docs): minor fixes in the docs fixed indentation and corrected spellings --- .github/CONTRIBUTING.md | 134 +++++++++++++++++----------------- README.md | 52 +++++++------ packages/README.md | 8 +- packages/generators/README.md | 33 ++++++--- packages/info/README.md | 3 +- packages/init/README.md | 8 +- packages/migrate/README.md | 2 + packages/remove/README.md | 4 +- packages/serve/README.md | 2 + packages/update/README.md | 2 + packages/utils/README.md | 15 ++-- 11 files changed, 145 insertions(+), 118 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c3194a9eadc..f3517a18489 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -7,31 +7,31 @@ work is not in vain. Table of Contents -- [Issues](#issues) -- [Your first Contribution](#your-first-contribution) -- [Setup](#setup) - - [Using npm](#using-npm) - - [Using yarn](#using-yarn) -- [Running Tests](#running-tests) - - [Using npm](#using-npm-1) - - [Using yarn](#using-yarn-1) -- [Editor Config](#editor-config) -- [Dependencies](#dependencies) -- [Branching Model](#branching-model) -- [Naming a branch](#naming-a-branch) - - [Features](#features) - - [Fixes](#fixes) -- [Testing](#testing) -- [Pull Requests](#pull-requests) -- [Submitting a good Pull Request](#submitting-a-good-pull-request) -- [Commit message](#commit-message) - - [Commit Message Format](#commit-message-format) -- [Migrate with the CLI](#migrate-with-the-cli) - - [How it's being done](#how-its-being-done) - - [Structure of a transform](#structure-of-a-transform) - - [Further Work](#further-work) -- [Contributor License Agreement](#contributor-license-agreement) -- [Documentation](#documentation) +- [Issues](#issues) +- [Your first Contribution](#your-first-contribution) +- [Setup](#setup) + - [Using npm](#using-npm) + - [Using yarn](#using-yarn) +- [Running Tests](#running-tests) + - [Using npm](#using-npm-1) + - [Using yarn](#using-yarn-1) +- [Editor Config](#editor-config) +- [Dependencies](#dependencies) +- [Branching Model](#branching-model) +- [Naming a branch](#naming-a-branch) + - [Features](#features) + - [Fixes](#fixes) +- [Testing](#testing) +- [Pull Requests](#pull-requests) +- [Submitting a good Pull Request](#submitting-a-good-pull-request) +- [Commit message](#commit-message) + - [Commit Message Format](#commit-message-format) +- [Migrate with the CLI](#migrate-with-the-cli) + - [How it's being done](#how-its-being-done) + - [Structure of a transform](#structure-of-a-transform) + - [Further Work](#further-work) +- [Contributor License Agreement](#contributor-license-agreement) +- [Documentation](#documentation) ## Issues @@ -55,14 +55,14 @@ In case you are suggesting a new feature, we will match your idea with our curre ## Setup -- Install [Node.js](https://nodejs.org/) if you don't have it already. +- Install [Node.js](https://nodejs.org/) if you don't have it already. _Note: Node 6 or greater would be better for "best results"._ -- Fork the **webpack-cli** repo at [https://github.com/webpack/webpack-cli](https://github.com/webpack/webpack-cli). -- `git clone && cd webpack-cli` +- Fork the **webpack-cli** repo at [https://github.com/webpack/webpack-cli](https://github.com/webpack/webpack-cli). +- `git clone && cd webpack-cli` ### Using npm -- Install the dependencies and link them: +- Install the dependencies and link them: ```bash npm install @@ -70,7 +70,7 @@ In case you are suggesting a new feature, we will match your idea with our curre npm link webpack-cli ``` -- Bootstrap all the submodules before building for the first time +- Bootstrap all the submodules before building for the first time ```bash npm run bootstrap @@ -79,13 +79,13 @@ In case you are suggesting a new feature, we will match your idea with our curre ### Using yarn -- If you don't have yarn yet: +- If you don't have yarn yet: ```bash npm install -g yarn ``` -- Install the dependencies and link them +- Install the dependencies and link them ```bash yarn @@ -93,7 +93,7 @@ In case you are suggesting a new feature, we will match your idea with our curre yarn link webpack-cli ``` -- Bootstrap all the submodules before building for the first time +- Bootstrap all the submodules before building for the first time ```bash yarn bootstrap @@ -104,38 +104,38 @@ In case you are suggesting a new feature, we will match your idea with our curre ### Using npm -- Run all the tests with: +- Run all the tests with: ```bash npm run test ``` -- Run CLI tests with: +- Run CLI tests with: ```bash npm run test:cli ``` -- Run tests of all packages: +- Run tests of all packages: ```bash npm run test:packages ``` -- Test a single CLI test case: +- Test a single CLI test case: ```bash npx jest path/to/my-test.js ``` -- You can also install jest globally and run tests without npx: +- You can also install jest globally and run tests without npx: ```bash npm i -g jest jest path/to/my-test.js ``` -- You can run the linters: +- You can run the linters: ```bash npm run lint @@ -143,44 +143,43 @@ In case you are suggesting a new feature, we will match your idea with our curre ### Using yarn -- Run all the tests with: +- Run all the tests with: ```bash yarn test ``` -- Run CLI tests with: +- Run CLI tests with: ```bash yarn test:cli` ``` -- Run tests of all packages: +- Run tests of all packages: ```bash yarn test:packages ``` -- Test a single CLI test case: +- Test a single CLI test case: ```bash yarn jest path/to/my-test.js ``` -- You can also install jest globally and run tests: +- You can also install jest globally and run tests: ```bash yarn global add jest jest path/to/my-test.js ``` -- You can run the linters: +- You can run the linters: ```bash yarn lint ``` - ## Editor Config The [.editorconfig](https://github.com/webpack/webpack-cli/blob/master/.editorconfig) in the root should ensure consistent formatting. Please make sure you've [installed the plugin](http://editorconfig.org/#download) if your text editor needs one. @@ -199,15 +198,15 @@ We base our branching model on [git flow](http://nvie.com/posts/a-successful-git Making a branch in your fork for your contribution is helpful in the following ways: -- It allows you to submit more than one contribution in a single PR. -- It allows us to identify what your contribution is about from the branch name. +- It allows you to submit more than one contribution in a single PR. +- It allows us to identify what your contribution is about from the branch name. You will want to checkout the `master` branch locally before creating your new branch. There are two types of branches: -- Feature -- Bugfix +- Feature +- Bugfix ### Features @@ -238,9 +237,9 @@ In case you've got a small change in most of the cases, your pull request would ## Submitting a good Pull Request -- Write tests -- Follow the existing coding style -- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) +- Write tests +- Follow the existing coding style +- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) ## Commit message @@ -258,6 +257,7 @@ format that includes a **type** and a **subject**: ```md : +