bulma/.github/CONTRIBUTING.md

72 lines
1.4 KiB
Markdown
Raw Normal View History

2016-04-10 17:47:14 +00:00
Thanks for helping out! 😇
### Raising an issue
* Make sure the issue hasn't been raised yet
* Include **screenshots** and animated GIFs in your issue whenever possible
### Submitting a Pull Request
* Include **screenshots** and animated GIFs in your pull request whenever possible
2016-09-11 12:53:13 +00:00
* Use the **present** tense ("Add feature" not "Added feature")
* Use the **imperative** mood ("Move cursor to..." not "Moves cursor to...")
* Limit the first line to 72 characters or fewer
2016-04-10 17:47:14 +00:00
* Reference issues and pull requests liberally
### Bulma Sass styleguide
* **No semi-colons** `;` or **curly braces** `{` `}`
* **No camelCase**
* Use only **classes**
* Order the CSS properties **alphabetically**
* Order the CSS rule by
* direct styles
* nested tags
* pseudo-classes
* color modifiers
* size modifiers
2016-04-10 17:47:14 +00:00
* modifiers
* responsive styles
* Add appropriate one-line comments for each of these sections within a CSS rule
* **No trailing space**
* End files with a **newline**
```sass
.element
@extend .something
+mixin
property: value
span
// ...
div
// ...
.child
// ...
&:pseudo-class
// ...
// Colors
@each $name, $pair in $colors
// Loop
// Sizes
&.is-small
// ...
&.is-medium
// ...
&.is-large
// ...
// Modifiers (ordered alphabetically)
&.has-icons
// ...
&.is-active
// ...
&.is-fullwidth
// ...
// Responsiveness
+mobile
// ...
+tablet
// ...
+desktop
// ...
```