Merge pull request #165 from merlijn-sebrechts/candidate

Update metadata
snapcrafters · Nov 29, 2023 · 0b16e65 · 0b16e65
2 parents e801187 + 8934833
commit 0b16e65
Show file tree

Hide file tree

Showing 3 changed files with 101 additions and 57 deletions.
diff --git a/README.md b/README.md
@@ -2,68 +2,94 @@
   <img src="https://discord.com/assets/ff41b628a47ef3141164bfedb04fb220.png" alt="Discord" width="50%">
 </h1>
 
-<p align="center"><b>This is the snap for Discord</b>, <i>"Discord is the easiest way to communicate over voice, video, and text. Chat, hang out, and stay close with your friends and communities."</i>. It works on Ubuntu, Fedora, Debian, and other major Linux distributions.</p>
+<p align="center"><b>This is the snap for Discord</b>. It is a community-maintained package to easily install Discord on Ubuntu, Fedora, Debian and other major Linux distributions. It is available in the Snap Store, Ubuntu Software, and a number of other applications.</p>
+
+<p align="center"><i>"Discord is the easiest way to communicate over voice, video, and text. Chat, hang out, and stay close with your friends and communities."</i></p>
+
 <p align="center">
 <a href="https://snapcraft.io/discord"><img src="https://snapcraft.io/discord/badge.svg" alt="Snap Status"></a>
 </p>
 
 ## Install
 
-    sudo snap install discord
-    sudo snap connect discord:camera core:camera
-    sudo snap connect discord:mount-observe core:mount-observe
-    sudo snap connect discord:network-observe core:network-observe
-    sudo snap connect discord:process-control core:process-control
-    sudo snap connect discord:removable-media
-    sudo snap connect discord:system-observe core:system-observe
+```shell
+snap install discord
+```
 
 ([Don't have snapd installed?](https://snapcraft.io/docs/core/install))
 
-![Discord](screenshot.png?raw=true "Discord")
-
 <p align="center">Published for <img src="https://raw.githubusercontent.com/anythingcodes/slack-emoji-for-techies/gh-pages/emoji/tux.png" align="top" width="24" /> with :gift_heart: by Snapcrafters</p>
 
-## Remaining tasks
-
-Snapcrafters ([join us](https://forum.snapcraft.io/t/join-snapcrafters/1325)) are working to land snap install documentation and the [snapcraft.yaml](https://github.com/snapcrafters/discord/blob/master/snap/snapcraft.yaml) upstream so Discord can authoritatively publish future releases.
-
-  - [x] Fork the [Snapcrafters template](https://github.com/snapcrafters/fork-and-rename-me) repository to your own GitHub account
-  - [x] Rename the forked Snapcrafters template repository
-  - [x] Update logos and references to `[Project]` and `[my-snap-name]`
-  - [x] Create a snap that runs in `devmode`
-  - [x] Register the snap in the store, **using the preferred upstream name**
-  - [x] Add a screenshot to this `README.md`
-  - [x] Publish the `devmode` snap in the Snap store edge channel
-  - [x] Add install instructions to this `README.md`
-  - [x] Update snap store metadata, icons and screenshots
-  - [x] Convert the snap to `strict` confinement, or `classic` confinement if it qualifies
-  - [x] Publish the confined snap in the Snap store beta channel
-  - [x] Update the install instructions in this `README.md`
-  - [ ] Post a call for testing on the [Snapcraft Forum](https://forum.snapcraft.io) - [link]()
-  - [x] Request your GitHub repository is forked to the Snapcrafters organisation and configured for automated builds
-  - [x] Add the provided Snapcraft build badge to this `README.md`
-  - [x] Publish the snap in the Snap store stable channel
-  - [x] Update the install instructions in this `README.md`
-  - [ ] Post an announcement in the [Snapcraft Forum](https://forum.snapcraft.io) - [link]()
-  - [ ] Submit a pull request or patch upstream that adds snap install documentation - *discussing with upstream*
-  - [ ] Submit a pull request or patch upstream that adds the `snapcraft.yaml` and any required assets/launchers - *discussing with upstream*
-  - [x] Add upstream contact information to the `README.md`
-  - If upstream accept the PR:
-    - [ ] Request upstream create a Snap store account
-    - [ ] Contact the Snap Advocacy team to request the snap be transferred to upstream
-  - [x] Ask the Snap Advocacy team to celebrate the snap - [link](https://insights.ubuntu.com/2017/05/04/discord-is-now-available-as-a-snap-for-ubuntu-and-other-distributions/)
-
-If you have any questions, [post in the Snapcraft forum](https://forum.snapcraft.io).
-
-## The Snapcrafters
-
-| [![Martin Wimpress](http://gravatar.com/avatar/ce95823a37d9ffa2e65a31cc60a2c42a/?s=128)](https://github.com/flexiondotorg/) |
-| :---: |
-| [Martin Wimpress](https://github.com/flexiondotorg/) |
-
-## Upstream
-
-| [![Chris Marsh](http://gravatar.com/avatar/288010bc9def7b7a1c68f417583407e9?s=128)](https://github.com/crmarsh) |
-| :---: |
-| [Chris Marsh](https://github.com/crmarsh) |
+## Snap configuration
+
+Discord by default does not have access to check which games are running on your system. If you want to enable this, run the following command.
+
+```shell
+snap connect discord:system-observe
+```
+
+Enabling this is also a good way to reduce the log spam from Discord's failed attempts at looking at other processes.
+
+## How to contribute to this snap
+
+Thanks for your interest! Below you find instructions to help you contribute to this snap.
+
+The general workflow is to submit pull requests that merges your changes into the `candidate` branch here on GitHub. Once the pull request has been merged, a GitHub action will automatically build the snap and publish it to the `candidate` channel in the Snap Store. Once the snap has been tested thoroughly, we promote it to the `stable` channel so all our users get it!
+
+### Initial setup
+
+If this is your first time contributing to this snap, you first need to set up your own fork of this repository.
+
+1. [Fork the repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) into your own GitHub namespace.
+2. [Clone your fork](https://git-scm.com/book/en/v2/Git-Basics-Getting-a-Git-Repository), so that you have it on your local computer.
+3. Configure your local repo. To make things a bit more intuitive, we will rename your fork's remote to `myfork`, and add the snapcrafters repo as `snapcrafters`.
+
+   ```shell
+   git remote rename origin myfork
+   git remote add snapcrafters https://github.com/snapcrafters/discord.git
+   git fetch --all
+   ```
+
+### Submitting changes in a pull request
+
+Once you're all setup for contributing, keep in mind that you want the git information to be all up-to-date. So if you haven't "fetched" all changes in a while, start with that:
+
+```shell
+git fetch --all -p
+```
+
+Now that your git metadata has been updated you are ready to create a bugfix branch, make your changes, and open a pull request.
+
+1. All pull requests should go to the stable branch so create your branch as a copy of the stable branch:
+
+   ```shell
+   git checkout -b my-bugfix-branch snapcrafters/candidate
+   ```
+
+2. Make your desired changes and build a snap locally for testing:
+
+   ```shell
+   snapcraft --use-lxd
+   ```
+
+3. After you are happy with your changes, commit them and push them to your fork so they are available on GitHub:
+
+   ```shell
+   git commit -a
+   git push -u myfork my-bugfix-branch
+   ```
+
+4. Then, [open up a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) from your `my-bugfix-branch` to the `snapcrafters/candidate` branch.
+5. Once you've opened the pull request, it will automatically trigger the build-test action that will launch a build of the snap. You can watch the progress of the snap build from your pull request (Show all checks -> Details). Once the snap build has completed, you can find the built snap (to test with) under "Artifacts".
+6. Someone from the team will review the open pull request and either merge it or start a discussion with you with additional changes or clarification needed.
+7. Once the pull request has been merged into the stable branch, a GitHub action will rebuild the snap using your changes and publish it to the [Snap Store](https://snapcraft.io/discord) into the `candidate` channel. After sufficient testing of the snap from the candidate channel, one of the maintainers or administrators will promote the snap to the stable branch in the Snap Store.
+
+## Maintainers
+
+* [@popey](https://github.com/popey)
+* [@lucyllewy](https://github.com/lucyllewy)
+
+## License
 
+* The license of both the build files in this repository are MIT.
+* Discord itself is a proprietary application.
diff --git a/discord.webp b/discord.webp
diff --git a/snap/snapcraft.yaml b/snap/snapcraft.yaml
@@ -1,11 +1,29 @@
 name: discord
-base: core22
-version: 0.0.36
+title: Discord
 summary: Chat for Communities and Friends
 description: |
-  Discord is the easiest way to communicate over voice, video and text.
-  Chat, hang out, and stay close with your friends and communities.
+  Discord is the easiest way to communicate over voice, video, and text. Chat, hang out, and stay close with your friends and communities.
+
+  Snaps are confined, as such Discord may be unable to perform some of the tasks it typically does when unconfined. This may result in the system log getting spammed with apparmor errors. Granting access to the system-observe interface when in the snap will enable the features, and thus reduce the logging.
+
+  ```
+  snap connect discord:system-observe
+  ```
+
+  **Authors**
 
+  This snap is maintained by the Snapcrafters community, and is not necessarily endorsed or officially maintained by the upstream developers.
+
+website: https://discord.com/
+contact: https://github.com//snapcrafters/discord/issues
+issues: https://github.com//snapcrafters/discord/issues
+source-code: https://github.com//snapcrafters/discord
+license: Proprietary
+icon: discord.webp
+version: 0.0.36
+
+
+base: core22
 grade: stable
 confinement: strict
 assumes: