AverageMarcus/milligram
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Format all files fot he new definition

Browse Source
This commit is contained in:
CJ Patoilo
2020-05-15 01:20:35 -03:00
parent 831481f1c8
commit 9a63e760df
16 changed files with 16718 additions and 14597 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/contributing.md
+2 -10
View File
@@ -2,7 +2,6 @@
We would love for you to contribute to Milligram and help us make this even better! Start reading this document to see it is not difficult as you might have imagined.
## Table of Contents
- [Open an Issue](#open-an-issue)
@@ -13,12 +12,10 @@ We would love for you to contribute to Milligram and help us make this even bett
- [Code of Conduct](#code-of-conduct)
- [License](#license)
## Open an Issue
[Open an Issue](../../../issues/new) to report any problems or improvements. When necessary, use [Codepen](http://codepen.io/) to show the problem. Be sure to include some description to explain the problem.
## Submit a Pull Request
To submit a new feature, make sure that changes are done to the source code. [Follow our style guide](#style-guide) and do not forget the tests and attach the link [Codepen](http://codepen.io/) along with the description.
@@ -35,14 +32,12 @@ You can do all of this from your browser using Gitpod, the free online dev envir
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/milligram/milligram)
*Note: For issues relating to the site, please use the [milligram.github.io](https://github.com/milligram/milligram.github.io)*
_Note: For issues relating to the site, please use the [milligram.github.io](https://github.com/milligram/milligram.github.io)_
## Building
First install [Node.js](https://nodejs.org/en/download/) for the build process. Now install all the dependencies, run `npm install` from the project directory. Once you have the dependencies installed, run `npm start`. This will run the build task which compiles the Sass files into Milligram.css file in the expanded and compressed version.
## Style Guide
Milligram use [Sass](http://sass-lang.com/) to give super powers to CSS. Look at how the code is being maintained, we must always be consistent. We try to follow best practices as much as possible. In addition, here are some tips you should follow:
@@ -82,19 +77,16 @@ Milligram use [Sass](http://sass-lang.com/) to give super powers to CSS. Look at
color: #000
```
*Note: This style guide was inspired by [Idiomatic.css](https://github.com/necolas/idiomatic-css). Milligram uses an `.editorconfig` file, which most editors support, to enforce these coding standards.*
_Note: This style guide was inspired by [Idiomatic.css](https://github.com/necolas/idiomatic-css). Milligram uses an `.editorconfig` file, which most editors support, to enforce these coding standards._
## Test
Breaking CSS is easy. Checking every responsive page element is hard. That's why Milligram uses automated visual regression testing for responsive web UI by comparing DOM screenshots at various viewport sizes. To view the comparison run `npm test` after making changes to the source code.
## Code of Conduct
Help us keep Milligram open and inclusive. Please read and follow our thoughts on [Code of Conduct](http://confcodeofconduct.com/).
## License
By contributing your code, you agree to license your contribution under the [MIT license](../license).
.github/issue_template.md
-5
View File
@@ -16,7 +16,6 @@ By contributing your code, you agree to license your contribution under the [MIT
-->
### Version info
<!-- What versions of the following libraries are you using? Note that your issue may already
@@ -26,22 +25,18 @@ be fixed in the latest versions. -->
**Other (e.g. normalize.css, node.js, npm, bower, browser, operating system) (if applicable):**
### Test case
<!-- Provide code samples on [Codepen](http://codepen.io/). -->
### Steps to reproduce
<!-- Provide the steps needed to reproduce the issue given the above test case. -->
### Expected behavior
<!-- What is the expected behavior? -->
### Actual behavior
<!-- What is the actual behavior? -->
.github/pull_request_template.md
-1
View File
@@ -26,7 +26,6 @@ By contributing your code, you agree to license your contribution under the [MIT
-->
### Description
<!-- Are you fixing a bug? Implementing a new feature? Updating the documentation? Describe here something about your changes. Don't forget to add the link to the open issue, or to other pull request related. -->