Skip to content

Commit

Permalink
fix(doc) grammar corrections + add pull request template file
Browse files Browse the repository at this point in the history
  • Loading branch information
triathete23 authored and guillaumechervetaxa committed Feb 8, 2019
1 parent eb4c608 commit d4714ab
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 27 deletions.
10 changes: 5 additions & 5 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
8 changes: 4 additions & 4 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

<!-- Describe your issue and tell us how to reproduce it (include any useful information). -->

### Versions
#### Versions

### Screenshots
#### Screenshots

#### Expected

#### Actual

### Additional Details
#### Additional Details

- Installed packages:
- Installed packages
2 changes: 1 addition & 1 deletion PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
```
33 changes: 16 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand All @@ -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

Expand Down

0 comments on commit d4714ab

Please sign in to comment.