Merge pull request #34 from mohsenshafiei/dev

Dev

Author: moshafiei

CONTRIBUTING.md

@@ -0,0 +1,48 @@
+## Contributing
+
+#### Reporting Bugs, Enhancements or etc
+
+Before creating bug reports, please check issues list as you might find out that you don't need to create one.
+ When you are creating a bug report, please include as many details as possible.
+
+ > **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open
+  a new issue and include a link to the original issue in the body of your new one.
+
+
+#### Pull Requests
+
+The team lead is monitoring for pull requests. Your team lead will review your pull request and either merge it,
+request changes to it, or close it with an explanation.
+
+*Before submitting a pull request*, please make sure the following is done:
+
+- clone the repository and create your branch from dev branch.
+- Run npm install in the repository root.
+- If you’ve fixed a bug or added code that should be tested, add tests!
+- Ensure the test suite passes (npm run test).
+- Format your code with prettier (npm run prettier)
+- Make sure your code lints (npm run lint).
+- Run the TypeScript type checks.
+
+#### Commits
+
+* Use the present tense ("Add feature" not "Added feature")
+* Limit the first line to 72 characters or less
+* Reference issues and pull requests liberally after the first line
+* Consider starting the branch names:
+     * `feature/` A new feature
+     * `bugfix/` A bug fix
+     * `document/`Documentation only changes
+     * `style/` Changes that do not affect the code
+     * `refactor/` A code change that neither fixes a bug or adds a feature
+     * `performance/` A code change that improves performance
+     * `test/` Adding missing tests
+* Consider starting the commit message with:
+     * `feat:` A new feature
+     * `fix:` A bug fix
+     * `docs:` Documentation only changes
+     * `style:` Changes that do not affect the code
+     * `refactor:` A code change that neither fixes a bug or adds a feature
+     * `perf` A code change that improves performance
+     * `test` Adding missing tests
+* Don't forget to put the <b>DOT</b> at the end of your commit

README.md

@@ -95,56 +95,49 @@ chain the
 
 `quark-loader` process the `CSS` files and replaced our style with a reference to our declarations. In this way, we can remove repetitive styles from our CSS and make it minimum.
 
+![What actually happens?](/public/assets/process.png)
+
 **style.css**
 ```css
-.container {
+.a {
   top: 100px;
-  left: 100px;
-  right: 100px;
-  transform: translate(-50%);
-  float: left;
 }
-
-.element {
+.b {
+  top: 100px;
+}
+.c {
+  top: 100px;
+}
+.d {
   top: 100px;
-  border: 2px solid red;
 }
 ```
+**Let's review what we get at the end**
 
-**result.css**
-```css
-.top--100px {
+Extracted css file
+```CSS
+.t7E {
 	top: 100px;
 }
-.left--100px {
-	left: 100px;
+.BOO {
 }
-.right--100px {
-	right: 100px;
+._1dA {
 }
-.transform--translate-50 {
-	transform: translate(-50%);
+._1rC {
 }
-.float--left {
-	float: left;
-}
-.border--2px-solid-red {
-	border: 2px solid red;
-}
-.container {
-	composes: top--100px;
-	composes: left--100px;
-	composes: right--100px;
-	composes: transform--translate-50;
-	composes: float--left;
-}
-.element {
-	composes: top--100px;
-	composes: border--2px-solid-red;
+._3e1 {
 }
 ```
-- Note that at the end you should compile your styles with [css-loader](https://github.com/webpack-contrib/css-loader).
-
+Without `CSS` extraction
+```js
+exports.locals = {
+	"top--100px": "t7E",
+	"a": "BOO t7E",
+	"b": "_1dA t7E",
+	"c": "_1rC t7E",
+	"d": "_3e1 t7E"
+};
+```
 #### Tutorials
 
 [Using Quark-Loader to minimize css files](https://medium.com)

ROADMAP.md

@@ -1,5 +1,14 @@
-# ROADMAP
+### Roadmap
 
-### WILL
-### WONT
-### MIGHT
+#### WILL
+- Full support of every possible `CSS` styling.
+- Reduce rules skips and duplications as much as possible.
+- Add different options and custom configuration for a better and customized result.
+- Creating a test case bank to make sure everything is working correctly
+
+#### WONT
+
+#### MIGHT
+- Integration with other task runners like gulp and etc
+
+***Please note that you can share your ideas about the project and how we can make it better together***