This is the unofficial snap packaging for [Project], Snaps are universal Linux packages.
Refer snap/README.md for user-oriented information.
Snapcrafters (join us) are working to land snap install documentation and the snapcraft.yaml upstream so [Project] can authoritatively publish future releases.
-
Create snap_name-snap (or any valid name you prefer) repository via the Use this template button above
It is recommended to *avoid forking the template repository* unless you're working on the template itself because you can only fork a repository once
-
Update the description of the repository
-
Update logos and references to
[Project]
,my-awesome-app
,_namespace_
,_project_
, and other placeholder names inREADME.md
,snap/README.md
, andsnap/snapcraft.yaml
-
Add upstream contact information to this
README.md
-
Create a snap that runs in
devmode
, or inclassic
confinement if that's not possible- If the snap must be packaged under
classic
confinement, file a classic confinement request topic in the Snapcraft Forum, under thestore
topic category - template - link
- If the snap must be packaged under
-
Add a screenshot to
snap/README.md
-
Register the snap in the Snap Store, using the preferred upstream name(i.e. without custom postfix). If the preferred upstream name is not available or reserved, file a request to take over the preferred upstream name and temporary use a name with personal postfix instead.
-
Setup build.snapcraft.io and publish the
devmode
snap in the Snap Store edge channel -
Add the provided Snapcraft build badge to
snap/README.md
-
Update snap's metadata, icons and screenshots on the dashboard
-
Add install instructions to
snap/README.md
-
File an Intent-To-Package issue/bug to the upstream's contact or issue/bug tracker to consolidate and let the upstream acknowledge the effort - template - link
-
Convert the snap to
strict
confinement, orclassic
confinement if it qualifies -
Publish the confined snap in the Snap Store beta channel
-
Update the install instructions in
snap/README.md
-
Post a call for testing on the Snapcraft Forum - template - link
-
Publish the snap in the Snap Store stable channel
-
Update the install instructions in
snap/README.md
-
Post an announcement in the Snapcraft Forum - template - link
-
Submit a pull request or patch upstream that adds the
snapcraft.yaml
and any required assets/launchers - example - link -
Submit a pull request or patch upstream that adds snap install documentation - example - link
If the upstream accepts the PRs AND willing to maintain the package on the Snap Store:
- Request upstream create a Snap Store developer account
- Create a topic under the
store
category in the Snapcrafters Forum to request the snap be transferred to upstream - template - link
If the upstream rejects the offer:
- Ask a Snapcrafters admin to fork your/upstream's repo into github.com/snapcrafters, transfer the snap name from you to snapcrafters, and configure the repo for automatic publishing into edge on commit - template - link
Finally:
- Ask the Snap Advocacy team to celebrate the snap - explanation - link
If you have any questions, post in the Snapcraft forum.
Unless otherwise noted(individual file's header/REUSE DEP5), this product is licensed under the MIT license, or any of its recent versions you would prefer.
This work complies to the REUSE Specification, refer the REUSE - Make licensing easy for everyone website for info regarding the licensing of this product.