awesome-selfhosted-data/.github/ISSUE_TEMPLATE/addition.md

57 lines
2.7 KiB
Markdown

---
name: Addition
about: Add new software to the list.
title: Add SOFTWARE_NAME
labels: addition, reviewers wanted
assignees: ''
---
<!-- DO NOT DELETE THE TEXT BELOW . Please make sure relevant boxes are checked [x] -->
Thanks for taking the time to suggest an addition to awesome-selfhosted!
Please fill out information below (all fields are mandatory unless noted otherwise):
```yaml
# software name
name: "My awesome software"
# URL of the software project's homepage
website_url: "https://my.awesome.softwar.e"
# URL where the full source code of the program can be downloaded
source_code_url: "https://gitlab.com/awesome/software"
# description of what the software does, shorter than 250 characters, sentence case
description: "Description of my awesome software."
# list of license identifiers, see https://github.com/awesome-selfhosted/awesome-selfhosted-data/blob/master/licenses.yml for the full list of licenses
licenses:
- Apache-2.0
- AGPL-3.0
# list of languages/platforms, see https://github.com/awesome-selfhosted/awesome-selfhosted-data/tree/master/platforms for the full list of platforms
platforms:
- Java
- Python
- PHP
- Nodejs
- Deb
- Docker
# list of tags (categories), see https://github.com/awesome-selfhosted/awesome-selfhosted-data/tree/master/tags for the full list of tags
tags:
- Automation
- Calendar & Contacts
- Bookmarks and Link Sharing
- Pastebins
# (optional, true/false, default false) whether the software depends on a third-party service outside the user's control
depends_3rdparty: true
# (optional) link to an interactive demo of the software
demo_url: "https://my.awesome.softwar.e/demo"
# (optional) link to a list of clients/addons/plugins/apps/bots... for the software
related_software_url: "https://my.awesome.softwar.e/apps"
```
To ensure your issue is dealt with swiftly, please check the following (check the boxes `[x]`):
- [ ] Submit one item per issue. This eases reviewing and speeds up inclusion.
- [ ] You have searched the repository for any relevant [issues](https://github.com/awesome-selfhosted/awesome-selfhosted-data/issues) or [PRs](https://github.com/awesome-selfhosted/awesome-selfhosted-data/pulls), including closed ones.
- [ ] Any software you are adding is not already listed at any of [awesome-sysadmin](https://github.com/awesome-foss/awesome-sysadmin), [staticgen.com](https://www.staticgen.com/), [staticsitegenerators.bevry.me](https://staticsitegenerators.bevry.me/), [dbdb.io](https://dbdb.io/browse).
- [ ] Any software project you are adding to the list is actively maintained.
- [ ] Any software project you are adding was first released more than 4 months ago.
- [ ] Any software project you are adding has working installation instructions.