mirror of
https://github.com/awesome-selfhosted/awesome-selfhosted.git
synced 2025-10-26 09:41:40 +00:00
Merge pull request #1385 from nodiscc/refactor-contributing-cleanup
Refactor CONTRIBUTING, PR template, cleanup
This commit is contained in:
nodiscc
GitHub
24
.github/CONTRIBUTING.md
vendored
24
.github/CONTRIBUTING.md
vendored
@@ -1,16 +1,14 @@
|
||||
## Contributing
|
||||
|
||||
Please join us on [chat](https://chat.awesh.unknownplus.com/channel/awesome-selfhosted) to clarify any questions.
|
||||
Please open a new issue to clarify any questions, or post in the [General discussion issue](https://github.com/Kickball/awesome-selfhosted/issues/89).
|
||||
|
||||
All guidelines for adding new software to the list are listed in [PULL_REQUEST_TEMPLATE.md](PULL_REQUEST_TEMPLATE.md).
|
||||
|
||||
Other recommendations:
|
||||
|
||||
- To add a new entry, [edit the README.md file](https://github.com/Kickball/awesome-selfhosted/edit/master/README.md) through Github's web interface or a text editor, and send a Pull Request.
|
||||
- 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 script to help you format new entries is available at (it requires `make` to be installed): `git clone`/[download](https://github.com/Kickball/awesome-selfhosted/archive/master.zip) and enter the repository, run `make add` and follow the instructions.
|
||||
- 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.
|
||||
|
||||
* 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.
|
||||
* 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`.
|
||||
* Software with no development activity for 6-12 months may be removed from the list.
|
||||
|
||||
7
.github/PULL_REQUEST_TEMPLATE.md
vendored
7
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -7,9 +7,10 @@ To ensure your PR is dealt with swiftly please check the following:
|
||||
``- [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 [Free software](https://en.wikipedia.org/wiki/Free_software), or if not they have been added to [non-free](non-free.md) and marked `⊘ Proprietary`.
|
||||
- [ ] 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).
|
||||
- [ ] Your additions have their `License` main server-side `Language`/platform/requirement listed.
|
||||
- [ ] 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](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.
|
||||
- [ ] 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), incluing closed ones.
|
||||
- [ ] Any category you are creating has the minimum requirement of 3 items. If not, your addition may be inserted into `Misc/Other`.
|
||||
- [ ] Any software project you are adding to the list is actively maintained.
|
||||
@@ -1,4 +1,7 @@
|
||||
#Check for changes to README.md
|
||||
# Danger CI configuration file
|
||||
# https://danger.systems/guides/getting_started.html
|
||||
|
||||
# Check for changes to README.md
|
||||
has_readme_changes = git.modified_files.include?("README.md")
|
||||
|
||||
# Ensure there is a summary for a pull request
|
||||
@@ -8,7 +11,7 @@ fail 'Please provide a summary in the Pull Request description' if github.pr_bod
|
||||
warn 'Please check PR guidelines and check the boxes.' if github.pr_body.include? '- [ ]'
|
||||
|
||||
# Warn if pull request is not updated
|
||||
warn 'Please update the Pull Request title to contain the script name' if github.pr_title.include? 'Update README.md'
|
||||
warn 'Please provide a descriptive title for the Pull Request' if github.pr_title.include? 'Update README.md'
|
||||
|
||||
# Warn when there are merge commits in the diff
|
||||
warn 'Please rebase to get rid of the merge commits in this Pull Request' if git.commits.any? { |c| c.message =~ /^Merge branch 'master'/ }
|
||||
|
||||
2
Makefile
2
Makefile
@@ -26,7 +26,7 @@ listlicenses:
|
||||
@sed -n -e '/BEGIN SOFTWARE LIST/,/END SOFTWARE LIST/ p' README.md | egrep --only-matching '([Aa0-Zz9]|\s|\.|-)*` `' README.md | sort --unique
|
||||
|
||||
syntaxerrors:
|
||||
@echo -e "\n Syntax errors:"
|
||||
@echo -e "\nSyntax errors:"
|
||||
@! sed -n -e '/BEGIN SOFTWARE LIST/,/END SOFTWARE LIST/ p' README.md | egrep '\)\(|``|\)`'
|
||||
|
||||
contrib:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Awesome-Selfhosted
|
||||
|
||||
[](https://github.com/sindresorhus/awesome) [](https://chat.awesh.unknownplus.com/channel/awesome-selfhosted)
|
||||
[](https://github.com/sindresorhus/awesome)
|
||||
|
||||
Selfhosting is the process of locally hosting and managing applications instead of renting from SaaS providers.
|
||||
|
||||
@@ -1395,12 +1395,11 @@ See also [Documentation Generators](#documentation-generators), [Wikimatrix](htt
|
||||
|
||||
**[`^ back to top ^`](#)**
|
||||
|
||||
- [Awesome Selfhosted Chat](https://chat.awesome-selfhosted.com) - Rocket.chat instance setup for the awesome selfhosted community.
|
||||
- [Awesome Big Data](https://github.com/onurakpolat/awesome-bigdata) - Curated list of awesome big data frameworks, resources and other awesomeness.
|
||||
- [Awesome Sysadmin](https://github.com/n1trux/awesome-sysadmin) - Curated list of amazingly awesome open source sysadmin resources.
|
||||
- [PRISM Break](https://prism-break.org/en/), [privacytools.io](https://www.privacytools.io/), [Alternative Internet](https://redecentralize.github.io/alternative-internet/), [Libre Projects](http://libreprojects.net/) - Lists of software aimed at privacy and decentralization (in some form).
|
||||
- Lists of software aimed at privacy and decentralization in some form: [PRISM Break](https://prism-break.org/en/), [privacytools.io](https://www.privacytools.io/), [Alternative Internet](https://redecentralize.github.io/alternative-internet/), [Libre Projects](http://libreprojects.net/)
|
||||
- Dynamic Domain Name services: [Afraid.org](https://freedns.afraid.org/domain/registry/), [Pagekite](https://pagekite.net/)
|
||||
- Communities/forums: [/r/selfhosted](https://www.reddit.com/r/selfhosted), [IndieWeb](https://indieweb.org/), [Auto-Hébergement (FR)](http://www.auto-hebergement.fr/)
|
||||
- Communities/forums: [/r/selfhosted](https://www.reddit.com/r/selfhosted), [IndieWeb](https://indieweb.org/)
|
||||
|
||||
--------------------
|
||||
|
||||
|
||||
Reference in New Issue
Block a user