bulma/.github/CONTRIBUTING.md
Hiren Mistry 333bcf85e1 Improve clarity in docs/readme (#2066)
* Improve instructions for docs contribution

* Fix link to docs/readme
2018-10-07 18:32:03 +02:00

83 lines
1.7 KiB
Markdown

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
* 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
* Reference issues and pull requests liberally
### Try your changes
When modifying any `.sass`, you will need to rebuild the css. You can do this by running:
```
npm install
npm run build
```
To see documentation changes check [the documentation readme](../docs/README.md).
### 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
* 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
// ...
```