diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ef45bb64..234db779 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,14 +4,17 @@ Thanks for helping out! 😇 * 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 +* 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 * 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 +* 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 ### Bulma Sass styleguide diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index c546fbaa..ac5fd9ef 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,16 +1,19 @@ -### Instructions +### PLEASE READ THE FOLLOWING INSTRUCTIONS -**THIS IS AN EXAMPLE TEMPLATE.** -**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!** 😇 +Tag your issue accordingly: -_[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 -* [ ] 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] * [ ] My **browser** is: * [ ] 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 of the bug, enhancement, or question] -[Please tag accordingly] +_[Description of the bug, enhancement, or question]_ ### Steps to Reproduce -1. [First Step] -2. [Second Step] -3. [and so on...] +1. _[First Step]_ +2. _[Second Step]_ +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]_ diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 8ab1b570..ecb39062 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,18 +1,15 @@ -### Instructions +### PLEASE READ THE FOLLOWING INSTRUCTIONS -**THIS IS AN EXAMPLE TEMPLATE.** -**Screenshots are more than welcome!** -**Please remove any unused content (including these instructions) before submitting your PR.** -**Thanks for helping out!** 😇 +Thanks for helping out! 😇 -* Pull the latest master branch +* 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 +* If your PR has lots of commits, **rebase** first +* 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