From c2e22d57100e0fe5aebd4dcdd3a24212b9e81001 Mon Sep 17 00:00:00 2001 From: Esa Juhana Date: Sat, 7 Oct 2017 12:16:33 +0300 Subject: [PATCH] Improve development setup experience by fixing misspelled areas --- CONTRIBUTING.md | 24 ++++++++++++------------ docs/development.md | 2 +- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eab673b..1179bde 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,21 +1,21 @@ # Issues -Before open issue, please make sure your problem/request is open or not. When open issue, please give following information if you can: +Before opening an issue, please make sure your problem/request doesn't exist. When you open issue, please provide the following information if possible: -* Example code or repo(Please keep it simple and minimal) -* Reproduce steps +* Example code or repo (please keep it simple and minimal) +* Steps to reproduce * `react-bootstrap-table2` version -Anyway, it's welcome to open issue to ask questions or feature request. +Anyway, you're welcome to open an issue to ask questions or discuss about a feature request. # Pull Requests -Check [here](./docs/development.md) for getting start development. +Check [here](./docs/development.md) for getting started with development. -* When you want to implement a new feature, please let us know(via issues). -* Please run test before opening PR and also remember to write test code. -* If you PR is trying to fix bug, please describe the bug when PR open. +* When you want to implement a new feature, please let us know (via issues). +* Please run tests before opening a PR and also remember to test the actual business logic. +* If your PR is trying to fix a bug, please describe the bug number with hashtag when creating the PR. -# For the member of react-bootstrap-table2 org +# For the members of react-bootstrap-table2 org -* Please convert ticket to issue when ticket move to `Ready` from `Backlog` in project -* Please write document if any new API/feature/props changed or added -* Please add story example if any new feature implement \ No newline at end of file +* Please convert the ticket to issue when is ticket moved from `Backlog` to `Ready` in project. +* Please write documentation if any new API/feature/props is changed or added. +* Please add a story example if any new feature is implemented \ No newline at end of file diff --git a/docs/development.md b/docs/development.md index bf91e47..372bfa9 100644 --- a/docs/development.md +++ b/docs/development.md @@ -13,7 +13,7 @@ $ npm start ``` ### Launch StoryBook -We use [storybook](https://storybook.js.org/) to list our examples and it also have hot reload from source code. Sometime, it is also a good entry point to develop. +We use [storybook](https://storybook.js.org/) to list our examples and it also has hot reload from source code. Sometimes, it is also a good entry point to development. ```bash $ cd packages/react-bootstrap-table2-example