From d4714abf0e900ea7baf11547ca7507892340bc05 Mon Sep 17 00:00:00 2001 From: Pavlo LIAHUSHYN Date: Tue, 15 Jan 2019 23:31:40 +0100 Subject: [PATCH] fix(doc) grammar corrections + add pull request template file --- CODE_OF_CONDUCT.md | 10 +++++----- ISSUE_TEMPLATE.md | 8 ++++---- PULL_REQUEST_TEMPLATE.md | 2 +- README.md | 33 ++++++++++++++++----------------- 4 files changed, 26 insertions(+), 27 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 8ac48d851..54f200511 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -6,20 +6,20 @@ updating documentation, submitting pull requests or patches, and other activities. We are committed to making participation in this project a harassment-free -experience for everyone, regardless of level of experience, gender, gender +experience for everyone, regardless of the experience level, gender, gender identity and expression, sexual orientation, disability, personal appearance, -body size, race, age, or religion. +body size, race, age or religion. -Examples of unacceptable behavior by participants include the use of sexual +Examples of unacceptable behaviour by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public -or private harassment, insults, or other unprofessional conduct. +or private harassment, insults or other unprofessional conduct. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team. -Instances of abusive, harassing, or otherwise unacceptable behavior may be +Instances of abusive, harassing or otherwise unacceptable behaviour may be reported by opening an issue or contacting one or more of the project maintainers. diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index dd5f3245f..fd083d714 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -2,14 +2,14 @@ -### Versions +#### Versions -### Screenshots +#### Screenshots #### Expected #### Actual -### Additional Details +#### Additional Details -- Installed packages: +- Installed packages diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index fcfe74ecf..cff96a58d 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -24,4 +24,4 @@ $ npm test -- --watch # For a specific file (e.g., in packages/context/__tests__/command.test.js) $ npm test -- --watch packages/action -``` +``` \ No newline at end of file diff --git a/README.md b/README.md index 5b416c316..81bd6fcdd 100644 --- a/README.md +++ b/README.md @@ -8,23 +8,22 @@ - [Getting Started](#getting-started) - [Packages](#packages) - [Concept](#concept) -- [How It Works](#how-it-works) +- [How Does It Work](#how-it-works) - [Contribute](#contribute) - [Roadmap](#roadmap) - [Demo](#demo) ## About -A set of independent components. -Awesome library based on HTML and CSS using BEM convention with a JavaScript react.js implementation. Each components are autonomous and extensible. Pick and use only what you need! +A set of independent components. Awesome library based on HTML and CSS using BEM convention with the JavaScript ReactJS implementation. Each components are autonomous and extensible. Pick and use only what you need! -**How is done css isolation?** +**How can you do CSS isolation?** -Only by using [BEM (Block Element Modifier)](http://getbem.com) css convention. No need of a intricate technologies, just pragatism. +Only by using [BEM (Block Element Modifier)](http://getbem.com) CSS convention. No need of the intricate technologies, just pragatism. -Component are simple to use (just drag and drog it), simple to customise (by using css modifier) to your own need. Each Components may evoluate internally (html, css, js) minimizing the impact on your application. +Components are simple to use (just drag and drog it), simple to customize (by using CSS modifier) to your own need. Each component may evaluate internally (HTML, CSS, JS) and minimize an impact on your application. -You can easily build a new app from scratch or integrate component into existing application. +You can easily build a new app from scratch or integrate some component into existing application. [html+css documentation website](https://axaguildev.github.io?target=react_toolkit_storybook) [react storybook website](https://axaguildev.github.io?target=react_toolkit_design) @@ -99,19 +98,19 @@ const MyAlertComponent => () => ( ## Concept -Each component should be autonomous (html + css + javascript) and extensible. +Each component should be autonomous (HTML + CSS + JS) and extensible. -## How It Works +## How Does It Work -- Html/Css : +- HTML/CSS : - - BEM convention is used in order to break css cascading problem - - Scss and css files are avalaible by component and can be overrided or extended - - [Html/Css Documentation](https://axaguildev.github.io?target=react_toolkit_storybook) + - BEM convention is used in order to break CSS cascading problem + - SCSS and CSS files are avalaible for every component and can be overrided or extended + - [HTML/CSS Documentation](https://axaguildev.github.io?target=react_toolkit_storybook) - React : - - Components are without state by default - - Some higher component level are statefull but feel free to use the stateless one if it not feet to your use case + - Components are stateless by default + - Some Higher Order Components (HOC) are stateful but feel free to use the stateless one if it fits your use case - [React documentation](https://axaguildev.github.io?target=react_toolkit_design) ## Contribute @@ -122,8 +121,8 @@ Each component should be autonomous (html + css + javascript) and extensible. ## Roadmap - Update general documentation -- Continu to migrate to TypeScript component by component -- Continu to fix and clean code. Make it simpler, faster, lighter +- Migrating to TypeScript all components +- Fix the issues and clean code. Make it simpler, faster, lighter ## Demo