diff --git a/.github/ISSUE_TEMPLATE/other.md b/.github/ISSUE_TEMPLATE/other.md index 610e648f88..756a5be7b1 100644 --- a/.github/ISSUE_TEMPLATE/other.md +++ b/.github/ISSUE_TEMPLATE/other.md @@ -4,5 +4,3 @@ about: Other issues. assignees: '' --- - -Please describe the issue below: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f93ba0db63..14e6da268a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -6,7 +6,7 @@ To ensure your Pull Request is dealt with swiftly, please check the following (c - [ ] Submit one item per pull request. 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/n1trux/awesome-sysadmin), [staticgen.com](https://www.staticgen.com/), [staticsitegenerators.net](https://staticsitegenerators.net/), [dbdb.io](https://dbdb.io/browse). -- [ ] The file you are adding is formatted as described in [addition.md](https://github.com/awesome-selfhosted/awesome-selfhosted/blob/master/.github/ISSUE_TEMPLATE/addition.md). +- [ ] The file you are adding is formatted as described in [addition.md](https://github.com/awesome-selfhosted/awesome-selfhosted-data/blob/master/.github/ISSUE_TEMPLATE/addition.md). - [ ] Comments and unused optional fields have been removed. - [ ] The file you are adding uses [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) file naming, for example `my-awesome-software.yml`. - [ ] Values for `platform` are the main **server-side** requirements for the software. Don't include frameworks or specific dialects. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..31aa4234b8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,88 @@ +# Contributing + +Don't know where to start? Check issues labeled [`help wanted`](https://github.com/awesome-selfhosted/awesome-selfhosted-data/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22), [`fix`](https://github.com/awesome-selfhosted/awesome-selfhosted-data/issues?q=is%3Aissue+is%3Aopen+label%3Afix) and [`curation`](https://github.com/awesome-selfhosted/awesome-selfhosted-data/issues?q=is%3Aissue+is%3Aopen+label%3Acuration). + +### Curation + +- Software with no development activity for 6-12 months may be removed from the list +- Unmaintained software without an active community and/or persistent security issues may be removed from the list +- Problems should be reported automatically: [![](https://github.com/awesome-selfhosted/awesome-selfhosted-data/actions/workflows/daily-checks.yml/badge.svg)](https://github.com/awesome-selfhosted/awesome-selfhosted-data/issues/1) + +### Add software to the list + +- [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). Please use [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) for file naming, for example `my-awesome-software.yml`. +- 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 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. + + +### Add a tag/category + +Tags represent functional categories/features of the software, and must be added to `tags/tag-name.yml` (use [existing tags](tags/) as example). Any tag must have a minimum of 3 software projects referencing it. The [`Miscellaneous`](tags/miscellaneous.yml) tag can be used for software not matching any existing category. + +```yaml +# project name +name: Project Management +# description of what this tag/category is about (markdown allowed) +description: '[Project management](https://en.wikipedia.org/wiki/Project_management) is the process of leading the work of a team to achieve all project goals within the given constraints.' +# (optional) list of related tags, by name +related_tags: + - Ticketing + - Task management & To-do lists +# (optional) external links +external_links: + - title: awesome-sysadmin/Code Review + url: https://github.com/awesome-foss/awesome-sysadmin#code-review +``` + +### Add a license + +[Free and Open-Source](https://en.wikipedia.org/wiki/Free_and_open-source_software) software licenses (preferably [SPDX identifier](https://spdx.org/licenses/), or custom licenses, must be added to `licenses.yml` (use [existing licenses](licenses.yml) as example): + +```yaml + # short license identifier +- identifier: ZPL-1.2 + # full license name + name: Zope Public License 1.2 + # link to the full license text + url: http://zpl.pub/page/zplv12 +``` + +### Add a language/platform + +Languages/requirements/technologies used to run or build the software should be listed in `platforms/platform-name.yml` (use [existing platforms](platforms/) as example): + +```yaml +# language/platform name +name: Java +# general description of the programming language or deployment platform (markdown allowed) +description: "[Java](https://en.wikipedia.org/wiki/Java_(programming_language)) is a high-level, class-based, object-oriented programming language that is designed to have as few implementation dependencies as possible." +``` + +### Other + +**Rename a tag/category:** the tag must be renamed in the appropriate `tags/mytag.yml` file. All references to it must be updated in `tags/*.yml` and `software/*.yml`. + +**Automated tasks:** + +```bash +$ make help +install install build tools in a virtualenv +import import data from original list at https://github.com/awesome-selfhosted/awesome-selfhosted +update_metadata update metadata from project repositories/API +awesome_lint check data against awesome-selfhosted guidelines +export_markdown render markdown export from YAML data (https://github.com/awesome-selfhosted/awesome-selfhosted) +export_html render HTML export from YAML data (https://nodiscc.github.io/awesome-selfhosted-html-preview/) +push_markdown commit and push changes to the markdown repository +push_html commit and push changes to the HTML site repository (amend previous commit and force-push) +url_check check URLs for dead links or other connection problems +authors update the AUTHORS file +clean clean files generated by automated tasks +help generate list of targets with descriptions +``` diff --git a/LICENSE b/LICENSE index 2ba9425992..59eb038c5e 100644 --- a/LICENSE +++ b/LICENSE @@ -1,5 +1,4 @@ -License: CC-BY-SA-3.0 - Creative Commons Attribution-ShareAlike 3.0 Unported +Creative Commons Attribution-ShareAlike 3.0 Unported . CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS LICENSE DOES NOT CREATE AN diff --git a/README.md b/README.md index 4ec053b396..46fe2fd7a9 100644 --- a/README.md +++ b/README.md @@ -6,93 +6,10 @@ This repository holds data used to generate https://github.com/awesome-selfhoste ## Contributing -Don't know where to start? Check issues labeled [`help wanted`](https://github.com/awesome-selfhosted/awesome-selfhosted-data/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22), [`fix`](https://github.com/awesome-selfhosted/awesome-selfhosted-data/issues?q=is%3Aissue+is%3Aopen+label%3Afix) and [`curation`](https://github.com/awesome-selfhosted/awesome-selfhosted-data/issues?q=is%3Aissue+is%3Aopen+label%3Acuration). - -### Curation - -- Software with no development activity for 6-12 months may be removed from the list -- Unmaintained software without an active community and/or persistent security issues may be removed from the list -- Problems should be reported automatically: [![](https://github.com/awesome-selfhosted/awesome-selfhosted-data/actions/workflows/daily-checks.yml/badge.svg)](https://github.com/awesome-selfhosted/awesome-selfhosted-data/issues/1) - -### Add software to the list - -- [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). Please use [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) for file naming, for example `my-awesome-software.yml`. -- 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 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. - - -### Add a tag/category - -Tags represent functional categories/features of the software, and must be added to `tags/tag-name.yml` (use [existing tags](tags/) as example). Any tag must have a minimum of 3 software projects referencing it. The [`Miscellaneous`](tags/miscellaneous.yml) tag can be used for software not matching any existing category. - -```yaml -# project name -name: Project Management -# description of what this tag/category is about (markdown allowed) -description: '[Project management](https://en.wikipedia.org/wiki/Project_management) is the process of leading the work of a team to achieve all project goals within the given constraints.' -# (optional) list of related tags, by name -related_tags: - - Ticketing - - Task management & To-do lists -# (optional) external links -external_links: - - title: awesome-sysadmin/Code Review - url: https://github.com/awesome-foss/awesome-sysadmin#code-review -``` - -### Add a license - -[Free and Open-Source](https://en.wikipedia.org/wiki/Free_and_open-source_software) software licenses (preferably [SPDX identifier](https://spdx.org/licenses/), or custom licenses, must be added to `licenses.yml` (use [existing licenses](licenses.yml) as example): - -```yaml - # short license identifier -- identifier: ZPL-1.2 - # full license name - name: Zope Public License 1.2 - # link to the full license text - url: http://zpl.pub/page/zplv12 -``` - -### Add a language/platform - -Languages/requirements/technologies used to run or build the software should be listed in `platforms/platform-name.yml` (use [existing platforms](platforms/) as example): - -```yaml -# language/platform name -name: Java -# general description of the programming language or deployment platform (markdown allowed) -description: "[Java](https://en.wikipedia.org/wiki/Java_(programming_language)) is a high-level, class-based, object-oriented programming language that is designed to have as few implementation dependencies as possible." -``` - -### Other - -**Rename a tag/category:** the tag must be renamed in the appropriate `tags/mytag.yml` file. All references to it must be updated in `tags/*.yml` and `software/*.yml`. - -**Automated tasks:** - -```bash -$ make help -install install build tools in a virtualenv -import import data from original list at https://github.com/awesome-selfhosted/awesome-selfhosted -update_metadata update metadata from project repositories/API -awesome_lint check data against awesome-selfhosted guidelines -export_markdown render markdown export from YAML data (https://github.com/awesome-selfhosted/awesome-selfhosted) -export_html render HTML export from YAML data (https://nodiscc.github.io/awesome-selfhosted-html-preview/) -push_markdown commit and push changes to the markdown repository -push_html commit and push changes to the HTML site repository (amend previous commit and force-push) -url_check check URLs for dead links or other connection problems -authors update the AUTHORS file -clean clean files generated by automated tasks -help generate list of targets with descriptions -``` +See [CONTRIBUTING.md](CONTRIBUTING.md) ## License -This list is under the [Creative Commons Attribution-ShareAlike 3.0 Unported License](LICENSE) +This list is under the [Creative Commons Attribution-ShareAlike 3.0 Unported License](LICENSE). +Terms of the license are summarized [here](https://creativecommons.org/licenses/by-sa/3.0/). +The list of authors can be found in the [AUTHORS](AUTHORS) file. diff --git a/markdown/footer.md b/markdown/footer.md index 59016cdc21..3f8597f34e 100644 --- a/markdown/footer.md +++ b/markdown/footer.md @@ -24,12 +24,10 @@ ## Contributing -Contributing guidelines can be found in [.github/CONTRIBUTING.md](https://github.com/awesome-selfhosted/awesome-selfhosted/blob/master/.github/CONTRIBUTING.md). - -## Authors - -The list of authors can be found in the [AUTHORS](https://github.com/awesome-selfhosted/awesome-selfhosted-data/blob/master/AUTHORS) file. +Contributing guidelines can be found [here](https://github.com/awesome-selfhosted/awesome-selfhosted-data/blob/master/CONTRIBUTING.md). ## License This list is under the [Creative Commons Attribution-ShareAlike 3.0 Unported](https://github.com/awesome-selfhosted/awesome-selfhosted/blob/master/LICENSE) License. +Terms of the license are summarized [here](https://creativecommons.org/licenses/by-sa/3.0/). +The list of authors can be found in the [AUTHORS](https://github.com/awesome-selfhosted/awesome-selfhosted-data/blob/master/AUTHORS) file.