From 17a68e60c9dcba3b1dbc44ae025d0fb4dc47e668 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Wed, 10 Aug 2022 18:40:48 +0200 Subject: [PATCH] doc: update issue template/formatting, deduplicate information --- .github/ISSUE_TEMPLATE/addition.md | 38 +++++++++++++++--------- README.md | 46 +++++------------------------- 2 files changed, 32 insertions(+), 52 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/addition.md b/.github/ISSUE_TEMPLATE/addition.md index 8a858f914c..367439f747 100644 --- a/.github/ISSUE_TEMPLATE/addition.md +++ b/.github/ISSUE_TEMPLATE/addition.md @@ -10,32 +10,44 @@ assignees: '' Thanks for taking the time to suggest an addition to awesome-selfhosted! Please fill out information below: + ```yaml -name: "My awesome software" # required -website_url: "https://my.awesome.softwar.e" # required, URL of the software project's homepage -source_code_url: "https://gitlab.com/awesome/software" # required, URL where the full source code of the program can be downloaded -description: "A description of my awesome software, shorter than 250 characters." # required -licenses: # required, see licenses.yml for the full list of licenses +# software/my-awesome-software.yml +name: "My awesome software" +# required, URL of the software project's homepage +website_url: "https://my.awesome.softwar.e" +# required, URL where the full source code of the program can be downloaded +source_code_url: "https://gitlab.com/awesome/software" +# required, description of what the software does, shorter than 250 characters, sentence case +description: "Description of my awesome software." +# required, see licenses.yml for the full list of licenses +licenses: - Apache-2.0 - AGPL-3.0 -platforms: # required, see platforms/ for the full list of platforms +# required, see platforms/ for the full list of platforms +platforms: - Java - Python - PHP - Nodejs - Deb - Docker -tags: # required, , see tags/ for the full list of tags +# required, see tags/ for the full list of tags +tags: - Automation - Calendar - File synchronization -depends_3rdparty: yes # required if the software depends on a third-party service outside the user's control -demo_url: "https://my.awesome.softwar.e/demo" # optional, link to an interactive demo of the software -related_software_url: "https://my.awesome.softwar.e/apps" # optional, link to a list of clients/addons/plugins/apps/bots... for the software +# required if the software depends on a third-party service outside the user's control, else remove +depends_3rdparty: yes +# 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: - +To ensure your issue is dealt with swiftly please check the following (check the boxes `[x]`): +- [ ] 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. - [ ] Submit one item per pull request. This eases reviewing and speeds up inclusion. -- [ ] Values of the `language` fields are the main **server-side** requirements for the software. Don't include frameworks or specific dialects. +- [ ] Values for `platform` are the main **server-side** requirements for the software. Don't include frameworks or specific dialects. - [ ] Any software project you are adding to the list is actively maintained. +- [ ] If creating new `tags`, any tag has the minimum requirement of 3 items. If not, your addition may be inserted into `Miscellaneous`. diff --git a/README.md b/README.md index 20c7a575cf..bbec4e1da4 100644 --- a/README.md +++ b/README.md @@ -18,47 +18,15 @@ Don't know where to start? Check issues labeled [`help wanted`](https://github.c ### Add new software to the list -- [ ] Please submit one item per issue/pull request. This eases reviewing and speeds up the addition process. -- [ ] Please check that your addition is not already listed at any of these lists (If it fits in one of those lists, please try to get it added there instead): - - [awesome-sysadmin](https://github.com/n1trux/awesome-sysadmin) - - [awesome-analytics](https://github.com/onurakpolat/awesome-analytics) - - [staticgen.com](https://www.staticgen.com/) - - [staticsitegenerators.net](https://staticsitegenerators.net/) -- [ ] Please search for relevant [issues](https://github.com/awesome-selfhosted/awesome-selfhosted-data/issues) or [pull requests](https://github.com/awesome-selfhosted/awesome-selfhosted-data/pulls), including closed ones. -- [ ] [Create a new `.yml` file](https://github.com/awesome-selfhosted/awesome-selfhosted-data/new/master/software) based on the template below in the `software/` directory: -```yaml -# software/my-awesome-software.yml -name: "My awesome software" # required -website_url: "https://my.awesome.softwar.e" # required, URL of the software project's homepage -source_code_url: "https://gitlab.com/awesome/software" # required, URL where the full source code of the program can be downloaded -description: "A description of my awesome software, shorter than 250 characters." # required -licenses: # required, see licenses.yml for the full list of licenses - - Apache-2.0 - - AGPL-3.0 -platforms: # required, see platforms/ for the full list of platforms - - Java - - Python - - PHP - - Nodejs - - Deb - - Docker -tags: # required, , see tags/ for the full list of tags - - Automation - - Calendar - - File synchronization -depends_3rdparty: yes # required if the software depends on a third-party service outside the user's control -demo_url: "https://my.awesome.softwar.e/demo" # optional, link to an interactive demo of the software -related_software_url: "https://my.awesome.softwar.e/apps" # optional, link to a list of clients/addons/plugins/apps/bots... for the software -``` +- [Create a new `software/software-name.yml` file](https://github.com/awesome-selfhosted/awesome-selfhosted-data/new/master/software), based on the template in [.github/ISSUE_TEMPLATES/addition.md](.github/ISSUE_TEMPLATE/addition.md). +- Remove comments and unused optional fields +- Enter a descriptive commit message (such as `add My Awesome software`) +- Select `Create a new branch for this commit and start a pull request` +- Click `Propose new file` +- Click `Create pull request` -- [ ] remove comments and unused optional fields -- [ ] enter a descriptive commit message (such as `add My Awesome software`) -- [ ] select `Create a new branch for this commit and start a pull request` -- [ ] click `Propose new file` -- [ ] click `Create pull request` - -If you are not comfortable sending a pull request, please copy/edit the template above and post it in a new [issue](https://github.com/awesome-selfhosted/awesome-selfhosted-data/issues) +If you are not comfortable sending a pull request, please open a new [issue](https://github.com/awesome-selfhosted/awesome-selfhosted-data/issues). In [single page mode](https://github.com/awesome-selfhosted/awesome-selfhosted) the software will only appear under the first category in its `tags` list, so choose wisely.