Documentation changes

ValentijnvdBeek · ValentijnvdBeek · commit 3b91f043e12c · 2018-09-21T02:03:56.000+02:00
diff --git a/.github/bug_report.md b/.github/bug_report.md
@@ -0,0 +1,21 @@
+A short description of what the issue is.
+
+## Expected Behaviour
+
+## Actual Behaviour
+
+## Steps to Reproduce
+
+  1.
+  2.
+  3.
+
+## Specifications
+ - Version of Clay: 2.0.0
+ - Python version:
+ - OS Type/version:
+ - VLC version: NA
+ - MPV version: NA
+
+## Screenshots
+Add screenshots if applicable
diff --git a/.github/feature_request.md b/.github/feature_request.md
@@ -0,0 +1,11 @@
+If applicable, a description of what problem or issue promoted you to begin with.
+
+# Your proposed solution/feature
+The way you would like us to solve this issue or how you would like
+the feature to work.
+
+# Alternatives
+Any alternative features or solutions you considered
+
+# Additional context
+Any other context, screenshots or mockups.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,10 @@
+**REMINDER: Please read our [contribution guidelines!](../CONTRIBUTING.rst)**
+
+Fixes #
+
+# Description
+A description of what merge request changes
+
+-
+-
+-
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,38 +1,48 @@
 Changelog
 ---------
 
-Clay 1.2.0
+Clay 2.0.0
 ==========
 
-* Support the MPRIS2 protocol (by Valentijn)
-* Remove X keybinds and drop the Gtk dependency (by Valentijn)
-* Fix the hanging thread issue when enabling X keybinds (by Valentijn)
+TBA
+
+* Support the MPRIS2 protocol
+* Remove X keybinds and drop the Gtk dependency
+* Artist and Album view
+* Notification actions
+* libmpv support
+* Rework of the internals
+* Enter appending songs in library or search view
+* Dropping of x keybinds
+* Fix #37: clay crashing without a running notification daemon (by @agg23)
+* Fix #38: no tracks displaying (by @agg3)
+* Fix #43: queue doesn't move to the next track (by @agg23)
 
 Clay 1.1.0
 ==========
 
 2018-08-09
 
-* Liked Songs Playlist (by Valentijn)
-* Thumbs Up / Thumbs Down (by Valentijn)
-* Alphabetical Sorting in Library View (by Valentijn)
-* Explicit Rating Icon (by Valentijn)
+* Liked Songs Playlist
+* Thumbs Up / Thumbs Down
+* Alphabetical Sorting in Library View
+* Explicit Rating Icon
 * OSD notifications
 * setproctitle to nicely display clay in process list
 * Various bugfixes
-* Fix #29 (customizable tab activation hotkeys)
-* Fix #31 (rating issues)
+* Fix #29: customizable tab activation hotkeys
+* Fix #31: rating issues
 
 Clay 1.0.0
 ==========
 
 2018-04-06
 
- * Configurable keybinds (by Valentijn)
- * Configurable colors (by Valentijn)
- * Pluggable X keybinds (by Valentijn)
+ * Configurable keybinds
+ * Configurable colors
+ * Pluggable X keybinds
  * "My stations" page (by @Fluctuz)
- * Better settings management (by Valentijn)
+ * Better settings management
  * Equalizer
  * Track caching indicator
  * Optimized settings & cache
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -0,0 +1,52 @@
+How to contribute to Clay
+======
+
+Bugs
+####
+
+Reporting bugs
+****
+- Please read the `README`_ carefully.
+- Search our `Github issues`_
+  to see whether it already has been reported.
+- Follow the relevant template.
+
+Feature request
+****
+Feature requests are always welcome but do keep in mind that it might
+take a very long time (or maybe forever!) until we get to it.
+
+Did you write a patch that fixes a bug?
+****
+- File a relevant issue if one doesn't already exist
+- Open a new pull request with the patch
+- Ensure the PR description describes the problem
+- Follow the code guidelines
+
+Any questions
+****
+Feel free to ask any questions on our irc channel:
+
+- Server: irc.oftc.net
+- Channel: **#clay**
+
+Code guidelines
+####
+
+Python guidelines
+****
+- Please follow `PEP 8`_
+- Write docstrings using the `Google Style Docstrings`_
+- Bare exceptions should be avoided
+
+Git guidelines
+****
+- Make sure that every commit functions an standalone unit.
+- Commit messages need to be descriptive
+- Pull requests that only change cosmetics will probably be denied.
+- Run a linter before commiting
+
+.. _README: README.md
+.. _Github issues: https://github.com/and3rson/Clay/issues
+.. _PEP 8: https://www.python.org/dev/peps/pep-0008/
+.. _Google Style Docstrings: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
diff --git a/README.md b/README.md
@@ -18,6 +18,7 @@
   * [Equalizer](#equalizer)
   * [Misc](#misc)
 - [Troubleshooting](#troubleshooting)
+- [Contributing](./CONTRIBUTING.rst)
 - [Credits](#credits)
 - [Changelog](./CHANGELOG.rst)
 
@@ -27,7 +28,7 @@
 
 Standalone command line player for Google Play Music.
 
-This app wouldn't be possible without the wonderful [gmusicapi] and [VLC] & MPV libraries.
+This app wouldn't be possible without the wonderful [gmusicapi] and [VLC] & [MPV] libraries.
 
 This project is neither affiliated nor endorsed by Google.
 
@@ -162,10 +163,8 @@ Here's how you do it:
 You *should* get the sound working. Also docker will reuse the Clay config file from host (if you have one).
 
 # Remote control
-Clay supports the MPRIS2 protocol which allows users to remote control
-their Clay instances using generic tools like [playerctl]. This
-replaces the old X Hotkeys systems but does require you to manually
-bind the keys to your windowing system of choice.
+Clay supports the MPRIS2 protocol which allows users to remote control their Clay instances using generic tools like [playerctl].
+This replaces the old X Hotkeys systems but does require you to manually bind the keys to your windowing system of choice.
 
 # Configuration
 
@@ -191,7 +190,8 @@ bind the keys to your windowing system of choice.
 
 ## Songs
 
-- `<ENTER>` - play highlighted track
+- `<ENTER>` - add highlighted track to the queue
+- `<CTRL> p` - start or pause the queue
 - `<CTRL> w` - play/pause
 - `<CTRL> e` - play next song
 - `<CTRL> a` - append highlighted song to the queue
@@ -242,9 +242,11 @@ People who contribute to this project:
 - [@ValentijnvdBeek (Valentijn)](https://github.com/ValentijnvdBeek)
 - [@Fluctuz](https://github.com/Fluctuz)
 - [@sjkingo (Sam Kingston)](https://github.com/sjkingo)
+- [@agg23 (Adam Gastineau)](https://github.com/agg23)
 
 [gmusicapi]: https://github.com/simon-weber/gmusicapi
 [VLC]: https://wiki.videolan.org/python_bindings
+[MPV]: https://mpv.io/
 [urwid]: http://www.urwid.org/
 [pyyaml]: https://github.com/yaml/pyyaml
 [PyGObject]: https://pygobject.readthedocs.io/en/latest/getting_started.html
