From 7ccb43c576050f7d4ec75831c02494786d753594 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Thu, 28 Dec 2017 13:30:02 +0100 Subject: [PATCH] Update CONTRIBUTING.md, PULL_REQUEST_TEMPLATE.md, Makefile: * Update syntax guidelines according to new indentation convetion * Include relevant information in both files * Wording --- .github/CONTRIBUTING.md | 11 +++++++---- .github/PULL_REQUEST_TEMPLATE.md | 5 +++-- Makefile | 2 +- 3 files changed, 11 insertions(+), 7 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index bd2c2fc7..3fe7c909 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,12 +2,15 @@ Please join us on [chat](https://chat.awesh.unknownplus.com/channel/awesome-selfhosted) to clarify any questions. - * The **syntax** for links is ``[Name](http://homepage/) - Short description. ([Demo](http://url.to/demo), [Source Code](http://url.of/source/code)) `License` `Language` ``. All projects should have their **license** and main server-side **language**/platform/requirement listed, and a description at most 250 characters long. + * The **syntax** for links is ``- [Name](http://homepage/) - Short description. ([Demo](http://url.to/demo), [Source Code](http://url.of/source/code)) `License` `Language` ``. + * All projects must have their **license** and main server-side **language**/platform/requirement listed + * Project descriptions must be less than 250 characters long. + * Entries must be ordered alphabetically. + * Entries in README.md must be [Free Software](https://en.wikipedia.org/wiki/Free_software). + * Non-[Free](https://en.wikipedia.org/wiki/Free_software) software must be marked `⊘ Proprietary` next to the title, and added to [non-free.md](../non-free.md). * To **add an entry**: clone/[download](https://github.com/Kickball/awesome-selfhosted/archive/master.zip) and enter the repository, run `make add` and follow the instructions; or [edit the README.md file](https://github.com/Kickball/awesome-selfhosted/edit/master/README.md) directly. See [Editing files in another user's repository](https://help.github.com/articles/editing-files-in-another-user-s-repository/), [Creating Pull Requests](https://help.github.com/articles/creating-a-pull-request/), [Using Pull Requests](https://help.github.com/articles/using-pull-requests/) for help on sending your patch. * A minimum of 3 entries are required to start a new category, otherwise add to the Misc/Other category. - * Entries should be ordered alphabetically. - * Non-[Free](https://en.wikipedia.org/wiki/Free_software) software must be marked `⊘ Proprietary` next to the title, and added to [non-free.md](../non-free.md). * The `⚠` character must be inserted for software that relies on a third party service the user does not control, e.g ``[Name](http://homepage/) `⚠` - Short description...``. * Check current [issues](https://github.com/Kickball/awesome-selfhosted/issues) and [Pull Requests](https://github.com/Kickball/awesome-selfhosted/pulls), as well as [closed issues/PRs](https://github.com/Kickball/awesome-selfhosted/pulls?utf8=%E2%9C%93&q=is%3Aclosed+). - * The list of contributors can be updated with `make contrib`. Several checks are available: `make noexternallink; make nolicenselanguage; make nofullstop; make longdescriptions; make listlicenses; make syntaxerrors` or run all with `make checks`. + * The list of contributors can be updated with `make contrib`. * Software with no development activity for 6-12 months may be removed from the list. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d660e63d..5641f828 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,11 +4,12 @@ To ensure your PR is dealt with swiftly please check the following: - [ ] Your submissions are formatted according to the guidelines. - ``[Name](http://homepage/) - Short description. ([Demo](http://url.to/demo), [Source Code](http://url.of/source/code)) `License` `Language` `` + ``- [Name](http://homepage/) - Short description, less than 250 characters. ([Demo](http://url.to/demo), [Source Code](http://url.of/source/code)) `License` `Language` `` - [ ] Your additions are ordered alphabetically. - [ ] Your additions are [Free software](https://en.wikipedia.org/wiki/Free_software), or if not they have been added to [non-free](non-free.md). - [ ] Your additions are not already listed at [awesome-sysadmin](https://github.com/n1trux/awesome-sysadmin) (IT infrastructure management), [staticgen.com](https://www.staticgen.com/) or [staticsitegenerators.net](https://staticsitegenerators.net/) (static site generators). - [ ] Any licenses you have added are in our [list of licenses](https://github.com/Kickball/awesome-selfhosted/blob/master/README.md#list-of-licenses). -- [ ] You have searched the repository for any relevant issues or PRs. +- [ ] You have searched the repository for any relevant [issues](https://github.com/Kickball/awesome-selfhosted/issues) or [PRs](https://github.com/Kickball/awesome-selfhosted/pulls). - [ ] Any category you are creating has the minimum requirement of 3 items. +- [ ] Any software project you are adding to the list is actively maintained. \ No newline at end of file diff --git a/Makefile b/Makefile index 00b366ae..4886ccea 100755 --- a/Makefile +++ b/Makefile @@ -53,7 +53,7 @@ add: else Moreinfo=$$(echo "($$CDemo$$CSource)" | sed 's|)\[|), [|g') ;\ fi ;\ echo -e "Copy this entry to your clipboard, paste it in the appropriate category:\n\n" ;\ - echo " * [$$Name]($$Url) - $${Description} $${Moreinfo} \`$$License\` \`$$Language\`" + echo "- [$$Name]($$Url) - $${Description} $${Moreinfo} \`$$License\` \`$$Language\`" #TODO ask for category and insert item accordingly