Skip to content

Commit

Permalink
Spices Repo: add ISSUE_TEMPLATE and CONTRIBUTING (linuxmint#193)
Browse files Browse the repository at this point in the history
  • Loading branch information
NikoKrause authored Sep 17, 2017
1 parent 9481edf commit a956e07
Show file tree
Hide file tree
Showing 3 changed files with 76 additions and 3 deletions.
29 changes: 29 additions & 0 deletions .github/CONTRIBUTING.md
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/)
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE
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**
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ There are two important directories:

As you can see, the content of the spice isn't placed inside UUID/files/ directly, but inside UUID/files/UUID/ instead. This guarantees files aren't extracted directly onto the file system, but placed in the proper UUID directory. The presence of this UUID directory, inside of files/ isn't actually needed by Cinnamon (as Cinnamon creates it if it's missing), but it is needed to guarantee a proper manual installation (i.e. when users download the ZIP from the Cinnamon Spices website).

Important note:

- The UUID/files/ directory has to be "empty", which means that it should contain ONLY the UUID directory. Else the spice won't be installable through System Settings.

At the root level:

- info.json contains information about the spice. For instance, this is the file which contains the github username of the spice's author.
Expand All @@ -57,6 +61,10 @@ Authors can modify their spice under the following conditions:

Authors are able to accept or refuse changes from other people which modify the features or the look of their spice.

Authors may choose to pass on development of their desklet to someone else. In that case, the "author" field in UUID/info.json will be changed to the new developer and the "original_author" field will be added to give credit to the original developer.

If an author abandons their desklet, the Linux Mint team will take over maintenance of the desklet or pass it on to someone else. Several factors are used to determine if an desklet is abandoned, including prolonged activity, failure to respond to requests, and serious breakages that have occurred due to changes in API, etc. If you plan to abandon a desklet, please notify us, so we don't have to guess as to whether it is abandoned or not.

# Pull requests from authors and workflow

To modify a spice, developers create a Pull Request.
Expand All @@ -73,13 +81,15 @@ If everything is fine, the PR is merged, the website is updated and users can se

# Pull requests from other people

In addition to the checks specified above, if the pull requests comes from somebody else than the author, the reviewer will need to check the nature of the changes.
In addition to the checks specified above, if the pull request comes from somebody other than the author, it will be held until the author reviews it or gives a thumbs-up, with the following exceptions:

If the changes represent a bug fix, the PR can be merged.
- If it is a bug fix, the PR may be merged, though if the bug is minor, or the fix could potentially impact the way the desklet works, we may wait for author approval before merging.
- If the pull request adds translations it will likewise be merged. These are not going to effect the functionality of the code, and will make the desklet available to many users who couldn't use it before due to a language barrier. We view this a essentially a bugfix, but it is included here for clarification.
- If the author fails to respond in a reasonable time, we will assume the desklet is abandoned (as mentioned above) and the pull request will be merged assuming it meets all other requirements.

If the changes represent a change in functionality, or in look and feel, or if their implementation could be questioned and/or discussed, the reviewer should leave the PR open and ask the author to review it.

If the author is happy with the PR, it can then be merged. If he's not, it can be closed instead.
If the author is happy with the PR, it can then be merged. If he's not, it can either be closed or updated to reflect any changes the author requested, at which point it will either be merged or the author may be asked to review the changes depending on whether it is clear the changes fully meet the author's requirements.

# Deletions

Expand All @@ -92,3 +102,7 @@ The Cinnamon team is also entitled to do so. Common reasons are lack of maintena
New spices can be added by Pull Request.

The Cinnamon team can accept or reject the addition and should give justification in the PR comments section.

# Reporting Bugs and Creating Pull Requests

See the [Guidelines for Contributing](https://github.com/linuxmint/cinnamon-spices-desklets/blob/master/.github/CONTRIBUTING.md)

0 comments on commit a956e07

Please sign in to comment.