Update contribution guidelines

This commit is contained in:
Jeremy Thomas 2016-09-11 13:53:13 +01:00
parent 3ed595516a
commit af0126956d
3 changed files with 34 additions and 28 deletions

View File

@ -4,14 +4,17 @@ Thanks for helping out! 😇
* Make sure the issue hasn't been raised yet * Make sure the issue hasn't been raised yet
* Include **screenshots** and animated GIFs in your issue whenever possible * Include **screenshots** and animated GIFs in your issue whenever possible
* Tag your issue accordingly: bug, enhancement, or question * Tag your issue accordingly:
* is it about **Bulma** or about the **Docs**?
* is it a **Bug**, a **Feature**, a **Question**, or do you need **Help**?
* if it's a bug, is it a **Browser Bug** (only happens in one browser)?
### Submitting a Pull Request ### Submitting a Pull Request
* Include **screenshots** and animated GIFs in your pull request whenever possible * Include **screenshots** and animated GIFs in your pull request whenever possible
* Use the present tense ("Add feature" not "Added feature") * Use the **present** tense ("Add feature" not "Added feature")
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...") * Use the **imperative** mood ("Move cursor to..." not "Moves cursor to...")
* Limit the first line to 72 characters or less * Limit the first line to 72 characters or fewer
* Reference issues and pull requests liberally * Reference issues and pull requests liberally
### Bulma Sass styleguide ### Bulma Sass styleguide

View File

@ -1,16 +1,19 @@
### Instructions ### PLEASE READ THE FOLLOWING INSTRUCTIONS
**THIS IS AN EXAMPLE TEMPLATE.** Tag your issue accordingly:
**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)**
**Screenshots are more than welcome!**
**Please remove any unused content (including these instructions) before submitting your issue.**
**Thanks for helping out!** 😇
_[Remove this line and all of the above before submitting your issue]_ * is it about Bulma or about the Docs?
* is it a bug/feature/question or do you need help?
* if it's a bug, is it a browser bug?
Thanks for helping out! 😇
Please remove any unused content (including these instructions) before submitting your issue.
### Checklist ### Checklist
* [ ] This is about Bulma the **CSS framework** and **not** about the Bulma website * [ ] This is about the Bulma **CSS framework**
* [ ] This is about the Bulma **Docs**
* [ ] I'm using Bulma **version** [x.x.x] * [ ] I'm using Bulma **version** [x.x.x]
* [ ] My **browser** is: * [ ] My **browser** is:
* [ ] This is a **Sass** issue: I'm using version [x.x.x] * [ ] This is a **Sass** issue: I'm using version [x.x.x]
@ -18,15 +21,18 @@ _[Remove this line and all of the above before submitting your issue]_
### Description ### Description
[Description of the bug, enhancement, or question] _[Description of the bug, enhancement, or question]_
[Please tag accordingly]
### Steps to Reproduce ### Steps to Reproduce
1. [First Step] 1. _[First Step]_
2. [Second Step] 2. _[Second Step]_
3. [and so on...] 3. _[and so on...]_
_Expected behavior:_ [What you expected to happen] ### Expected behavior
_Actual behavior:_ [What actually happened] _[What you expected to happen]_
### Actual behavior
_[What actually happened]_

View File

@ -1,18 +1,15 @@
### Instructions ### PLEASE READ THE FOLLOWING INSTRUCTIONS
**THIS IS AN EXAMPLE TEMPLATE.** Thanks for helping out! 😇
**Screenshots are more than welcome!**
**Please remove any unused content (including these instructions) before submitting your PR.**
**Thanks for helping out!** 😇
* Pull the latest master branch * Pull the latest `master` branch
* Run `npm install` to install all Bulma dependencies * 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) * 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 fixes an issue, reference that issue
* If your PR has lots of commits, **squash** your commits first * If your PR has lots of commits, **rebase** first
* Run `npm run build` before submitting your PR * Run `npm run build` and `npm run docs` before submitting your PR
_[Remove this line and all of the above before submitting your PR]_ Please remove any unused content (including these instructions) before submitting your issue.
### Pull Request ### Pull Request