mirror of
https://github.com/jgthms/bulma.git
synced 2024-11-14 11:14:24 +00:00
Add contribution templates
This commit is contained in:
parent
155f8442e0
commit
4d3aa5a51f
72
CONTRIBUTING.md
Normal file
72
CONTRIBUTING.md
Normal file
@ -0,0 +1,72 @@
|
||||
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
|
||||
* Tag your issue accordingly: bug, enhancement, or question
|
||||
|
||||
### 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 less
|
||||
* 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 modifers
|
||||
* 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
|
||||
// ...
|
||||
```
|
28
ISSUE_TEMPLATE.md
Normal file
28
ISSUE_TEMPLATE.md
Normal file
@ -0,0 +1,28 @@
|
||||
Thanks for helping out! 😇
|
||||
|
||||
### Prerequisites
|
||||
|
||||
If it's a bug on the **website**, submit an issue on the appropriate repository: [https://github.com/jgthms/bulma-website](https://github.com/jgthms/bulma-website)
|
||||
|
||||
* [ ] Is this about Bulma the **CSS framework** and **not** about the Bulma website?
|
||||
* [ ] Which **version** of Bulma are you using?
|
||||
* [ ] Which **browser** are you using?
|
||||
* [ ] If it's a **Sass** issue, which version of Sass are you using?
|
||||
* [ ] Are you sure this issue is not a **duplicate**?
|
||||
|
||||
### Description
|
||||
|
||||
[Description of the bug, enhancement, or question]
|
||||
[Please tag accordingly]
|
||||
|
||||
### Steps to Reproduce
|
||||
|
||||
1. [First Step]
|
||||
2. [Second Step]
|
||||
3. [and so on...]
|
||||
|
||||
_Expected behavior:_ [What you expected to happen]
|
||||
|
||||
_Actual behavior:_ [What actually happened]
|
||||
|
||||
**Screenshots** are more than welcome!
|
19
PULL_REQUEST_TEMPLATE.md
Normal file
19
PULL_REQUEST_TEMPLATE.md
Normal file
@ -0,0 +1,19 @@
|
||||
Fixes #
|
||||
|
||||
Changes proposed:
|
||||
|
||||
* [ ] Add
|
||||
* [ ] Fix
|
||||
* [ ] Remove
|
||||
* [ ] Update
|
||||
|
||||
### Requirements
|
||||
|
||||
* [ ] Pull the latest master branch
|
||||
* [ ] Run `npm install` to install all Bulma dependencies
|
||||
* [ ] Make sure your Sass code is compliant with the [Bulma Sass styleguide](https://github.com/jgthms/bulma/blob/master/CONTRIBUTING.md#bulma-sass-styleguide)
|
||||
* [ ] If your PR fixes an issue, reference that issue
|
||||
* [ ] If your PR has lots of commits, **squash** your commits first
|
||||
* [ ] Run `npm run build` before submitting your PR
|
||||
|
||||
Thanks for helping out! 😇
|
@ -31,6 +31,12 @@ You can either use that file, "out of the box", or download the Sass source file
|
||||
|
||||
There is **no** JavaScript included. People generally want to use their own JS implementation (and usually already have one). Bulma can be considered "environment agnostic": it's just the style layer on top of the logic.
|
||||
|
||||
## Roadmap
|
||||
|
||||
Bulma keeps track of the upcoming fixes and features on Trello: [Bulma roadmap](https://trello.com/b/5Lzqejo3/bulma-roadmap)
|
||||
|
||||
It's more a tasklist than a roadmap, but it will give you an overview of where things are going!
|
||||
|
||||
## Documentation website
|
||||
|
||||
This repository is **only** for the Bulma source files.
|
||||
|
Loading…
Reference in New Issue
Block a user