forked from linuxmint/cinnamon-spices-desklets
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Spices Repo: add ISSUE_TEMPLATE and CONTRIBUTING (linuxmint#193)
- Loading branch information
1 parent
9481edf
commit a956e07
Showing
3 changed files
with
76 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Reporting Bugs | ||
|
||
* It's important to use a proper title when opening new issues. The title must be in the format `spice name: simple description of the problem`. | ||
|
||
Issues that don't follow this format will be closed. | ||
|
||
You should mention the author on GitHub by typing @ plus his/her username to trigger a notification and bring his/her attention to an issue or pull request. | ||
You find the username of the author on the cinnamon spices website: https://cinnamon-spices.linuxmint.com/ | ||
|
||
If possible tell us | ||
* how exactly can we reproduce the error | ||
* what you expected to happen | ||
* what _actually_ happened | ||
* whether the problem happens consistently or intermittently | ||
* the version of Cinnamon and which Linux distro you are running | ||
|
||
# Creating Pull Requests | ||
|
||
* It's important to use a proper title in the **commit messages and pull requests**. The title must be in the format `spice name: simple description, what the commit/pull request does`. | ||
* One Pull Request - One Desklet. This avoids the risk of having to revert changes to multiple desklets if any problem is subsequently found with the PR. It also means that reviewing your changes is more straightforward. | ||
|
||
Pull Requests that don't follow this format will be closed. | ||
|
||
You should mention the author on GitHub by typing @ plus his/her username to trigger a notification and bring his/her attention to an issue or pull request. | ||
You find the username of the author on the cinnamon spices website: https://cinnamon-spices.linuxmint.com/ | ||
|
||
Nice to know | ||
* You can close issues through commit/pull request messages (https://help.github.com/articles/closing-issues-via-commit-messages/) | ||
* How to change the commit message (https://help.github.com/articles/changing-a-commit-message/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
<!-- Desklet's UUID should be in the title --> | ||
|
||
``` | ||
* Desklet version/Build date (to be found in "About.." or in "metadata.json") | ||
* Cinnamon version (cinnamon --version) | ||
* Distribution - (Mint 17.2, Arch, Fedora 25, etc...) | ||
* Graphics hardware *and* driver used | ||
* Snippet or attachment of ~/.cinnamon/glass.log | ||
* Snippet or attachment of ~/.xsession-errors | ||
|
||
``` | ||
|
||
<!-- Author list: https://github.com/linuxmint/cinnamon-spices-desklets/blob/master/.github/CODEOWNERS --> | ||
|
||
**Notify author of desklet** | ||
@ | ||
|
||
**Issue** | ||
|
||
|
||
|
||
**Steps to reproduce** | ||
|
||
|
||
|
||
**Expected behaviour** | ||
|
||
|
||
|
||
**Other information** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters