mirror of
				https://github.com/awesome-selfhosted/awesome-selfhosted.git
				synced 2025-10-31 20:59:39 +01:00 
			
		
		
		
	Update CONTRIBUTING.md, PULL_REQUEST_TEMPLATE.md, Makefile:
* Update syntax guidelines according to new indentation convetion * Include relevant information in both files * Wording
This commit is contained in:
		
							parent
							
								
									54119b211c
								
							
						
					
					
						commit
						7ccb43c576
					
				
					 3 changed files with 11 additions and 7 deletions
				
			
		
							
								
								
									
										11
									
								
								.github/CONTRIBUTING.md
									
										
									
									
										vendored
									
									
								
							
							
						
						
									
										11
									
								
								.github/CONTRIBUTING.md
									
										
									
									
										vendored
									
									
								
							|  | @ -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. | ||||
|  |  | |||
							
								
								
									
										5
									
								
								.github/PULL_REQUEST_TEMPLATE.md
									
										
									
									
										vendored
									
									
								
							
							
						
						
									
										5
									
								
								.github/PULL_REQUEST_TEMPLATE.md
									
										
									
									
										vendored
									
									
								
							|  | @ -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. | ||||
							
								
								
									
										2
									
								
								Makefile
									
										
									
									
									
								
							
							
						
						
									
										2
									
								
								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
 | ||||
|  |  | |||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue
	
	 nodiscc
						nodiscc