├── .github └── CODEOWNERS ├── README.md └── templates ├── copyright.md ├── contributor-guidelines.md ├── readme.md └── SECURITY,md /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | # The Anbox team 2 | * @canonical/anbox -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Standard repository templates 2 | 3 | This repository provides a collection of standard templates that can be reused when creating other GH repositories for charms, utilities or tools. 4 | 5 | ## Usage 6 | 7 | To use the templates available in this repository, copy the templates to your repository and fill them with the relevant information pertaining to your repository. 8 | 9 | ## Contributing guidelines 10 | 11 | If you would like to contribute to this collection of templates, please feel free to raise a pull request or an issue. 12 | -------------------------------------------------------------------------------- /templates/copyright.md: -------------------------------------------------------------------------------- 1 | # Copyright 2 | 3 | ## Copyright format 4 | Add the repository's source and contact details in the debian/copyright format. 5 | 6 | Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ 7 | 8 | Upstream-Name: < upstream name > 9 | 10 | Upstream-Contact: indore@lists.canonical.com 11 | 12 | Source: < source URL > 13 | 14 | ## Licenses for files and artifacts 15 | 16 | Add all relevant licenses for the files and artifacts in the following format 17 | For documentation only repositories, use the "Creative Commons Attribution Share-Alike license (CC-BY-SA)". 18 | 19 | Files: < file name and path > 20 | 21 | Copyright: 20xx Canonical Ltd 22 | 23 | License: Proprietary 24 | 25 | ## License terms 26 | 27 | Add all the listed license terms below 28 | 29 | License: < license-name > 30 | 31 | < license-details > 32 | -------------------------------------------------------------------------------- /templates/contributor-guidelines.md: -------------------------------------------------------------------------------- 1 | # Contributing guidelines 2 | 3 | The Anbox Cloud team appreciates contributions to the project, through pull requests, issues on [Launchpad](https://bugs.launchpad.net/anbox-cloud), or discussions and questions on the [forum](https://discourse.ubuntu.com/c/anbox-cloud/users/148). Use a valid account for contributions as anonymous contributions are *not* accepted. 4 | 5 | Check the following guidelines before contributing to the project. 6 | 7 | ## Code of Conduct 8 | 9 | When contributing, you must adhere to the [Code of Conduct](https://ubuntu.com/community/ethos/code-of-conduct). 10 | 11 | ## Copyright 12 | 13 | The code in this repository is proprietary and copyrighted to Canonical. See [Copyright](./copyright.md). 14 | 15 | ## License agreement 16 | 17 | All contributors must sign the [Canonical contributor license agreement (CLA)](https://ubuntu.com/legal/contributors), which gives Canonical permission to use the contributions. Without the CLA, contributions cannot be accepted. 18 | 19 | ## Pull requests 20 | 21 | Changes to this project should be proposed as pull requests on GitHub at: < repository link > 22 | 23 | Proposed changes will then go through review there and once approved, be merged in the main branch. 24 | -------------------------------------------------------------------------------- /templates/readme.md: -------------------------------------------------------------------------------- 1 | # < Introduction title > 2 | Provide a title that reflects what the repository delivers. For example: Anbox Management Service (AMS). 3 | Add a few lines about the tool/product/utility. 4 | 5 | ## Installation 6 | Include build and install instructions. Remember to include any prerequisites and additional configurations that need to be in place. 7 | 8 | ## Usage 9 | Include instructions or steps to use the tool/utility. 10 | 11 | ## Integrations 12 | (Optional) 13 | Include details about integrations required with any other components 14 | 15 | ## Security 16 | (Optional) 17 | Include instructions required to ensure security and also a means to report security vulnerabilities and issues. 18 | 19 | ## Cleanup 20 | (Optional) 21 | Include instructions on how to uninstall/remove and clean up. 22 | 23 | ## Licensing 24 | Include the licensing required for contributing to the repository and the terms and conditions for the same. 25 | For example, all Canonical repositories require a Contributor License Agreement (CLA) to be signed for contributions, include the instructions to sign the same. 26 | 27 | ## Contributing guidelines 28 | The following resources can help you get started: 29 | 30 | * [Contributing guide](./contributor-guidelines.md) 31 | * [Report a bug](https://bugs.launchpad.net/anbox-cloud) 32 | 33 | ## Next steps 34 | (Optional) 35 | Include information on what the users can do next after the initial setup and configuration. 36 | 37 | ## More information 38 | Explore more with the following resources: 39 | * [Anbox Cloud documentation](https://anbox-cloud.io/docs) 40 | * [Contact us](https://anbox-cloud.io/contact-us) 41 | * < Add links to related repositories > 42 | -------------------------------------------------------------------------------- /templates/SECURITY,md: -------------------------------------------------------------------------------- 1 | 2 | 3 | # Anbox Cloud security policy 4 | 5 | Learn about our [release and support policy](https://documentation.ubuntu.com/anbox-cloud/en/latest/reference/release-notes/release-notes/#release-and-support-policy) for the nature of our releases and versions. 6 | 7 | ## Reporting a vulnerability 8 | 9 | If you discover a security vulnerability, follow the steps outlined below to report it: 10 | 11 | 1. Do not publicly disclose the vulnerability before discussing it with us. 12 | 2. Report a bug at https://bugs.launchpad.net/anbox-cloud 13 | 14 | **Important**: Remember to set the information type to *Private Security*. You will see a field with the text *This bug contains information that is:* 15 | 3. Provide detailed information about the vulnerability, including: 16 | - A description of the vulnerability 17 | - Steps to reproduce the issue 18 | - Potential impact and affected versions 19 | - Suggested mitigation, if possible 20 | 21 | The [Ubuntu Security disclosure and embargo policy](https://ubuntu.com/security/disclosure-policy) contains more information about what you can expect when you contact us and what we expect from you. 22 | 23 | The Anbox Cloud team will be notified of the issue and review the vulnerability. We may reach out to you for further information or clarification if needed. 24 | If the issue is confirmed as a valid security vulnerability, we will assign a CVE and coordinate the release of the fix. We also document them as [security notices](https://documentation.ubuntu.com/anbox-cloud/en/latest/reference/security-notices/). 25 | --------------------------------------------------------------------------------