From e0b1ac2d5f27e2c0e061b152289427c4cf6f7b78 Mon Sep 17 00:00:00 2001 From: Edward D Date: Fri, 26 Aug 2016 12:54:17 +0200 Subject: Project Reoganisation (#718) * Create AUTHORS * Populate AUTHORS * Create and populate CONTRIBUTING.md * Update README sections Update README sections to reflect new files. * Minor Grammar Fix * Create and populate PULL_REQUEST_TEMPLATE.md Create the automated issue template for the repo. ([more info](https://help.github.com/articles/creating-a-pull-request-template-for-your-repository)) * Move CONTRIBUTING.md to .github/ * Add chat link to CONTRIBUTING.md * Update Formatting Guidelines * Update Formatting Guidelines * Remove example from PULL_REQUEST_TEMPLATE guidelines * Remove example from CONTRIBUTING guidelines --- .github/CONTRIBUTING.md | 12 ++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 12 ++++++++++++ 2 files changed, 24 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md (limited to '.github') diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..311e33ff --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,12 @@ +## Contributing + +Please join us on [chat](https://chat.awesome-selfhosted.com) 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. + * 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). + * 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 missinglicenselanguage; make nofullstop` + * 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 new file mode 100644 index 00000000..28876591 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,12 @@ +Thank you for taking the time to work on a PR for Awesome-selfhosted! + +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``` +- [ ] 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). +- [ ] 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. +- [ ] Any category you are creating has the minimum requirement of 3 items. -- cgit v1.2.3