CONTRIBUTING: made better
This commit is contained in:
		
							parent
							
								
									d2f8fb8106
								
							
						
					
					
						commit
						e889159619
					
				
							
								
								
									
										44
									
								
								CONTRIBUTING
									
									
									
									
									
								
							
							
						
						
									
										44
									
								
								CONTRIBUTING
									
									
									
									
									
								
							| @ -1,26 +1,29 @@ | ||||
| Make sure to read our code of conduct in the CONDUCT file. | ||||
| 
 | ||||
| When contributing a pull request to the main branch, please sign your commits | ||||
| with a PGP key and add your name and the year to the bottom of the list of | ||||
| copyright holders for the file. For example, an existing copyright header might | ||||
| read: | ||||
| 
 | ||||
| Copyright Information | ||||
| ===================== | ||||
| 
 | ||||
| When editing a file, create a copyright statement correlated to your | ||||
| identity so that it is easier to keep track of who has touched what file. | ||||
| Pseudonymous contributions are welcome (and encouraged). Place new copyright | ||||
| information below existing copyright information. If there is an existing | ||||
| copyright statement: | ||||
| 
 | ||||
|  * Copyright (c) 2022–2023 Emma Tebibyte <emma@tebibyte.media> | ||||
| 
 | ||||
| You would add your name below it like this: | ||||
| you would add your name below it like this: | ||||
| 
 | ||||
|  * Copyright (c) 2022–2023 Emma Tebibyte <emma@tebibyte.media> | ||||
|  * Copyright (c) 20XX Your Name <your e-mail address or website> | ||||
| 
 | ||||
| We accept contributions from people using aliases. | ||||
| 
 | ||||
| Only list years in which you modified the source file. For example: | ||||
| 
 | ||||
|  * Copyright (c) 2020–2021, 2023 Your Name <your-address@example.com> | ||||
| 
 | ||||
| This header shows that “Your Name” worked on this source file in 2020, 2021, and | ||||
| 2023. Please use the en dash (“–”) to separate the years in the copyright | ||||
| notice. | ||||
| 2023. Please use the en dash (“–”, U+2013) to separate consecutive years in the | ||||
| copyright notice. | ||||
| 
 | ||||
| If you are contributing a new file, please prepend the following license header | ||||
| text to it, replacing the proper text on the copyright line: | ||||
| @ -92,6 +95,10 @@ notice: | ||||
|  *     USE OR OTHER DEALINGS IN THE SOFTWARE. | ||||
|  */ | ||||
| 
 | ||||
| 
 | ||||
| Style | ||||
| ===== | ||||
| 
 | ||||
| Make sure lines never exceed 80 columns in width when using four-character | ||||
| indentation steps. This helps contributors with smaller screens, those using | ||||
| side-by-side editor windows or panes, and those who have no text wrapping in | ||||
| @ -99,12 +106,16 @@ their editor or terminal. | ||||
| 
 | ||||
| For usage text and help messages, do not implement a -h option. Instead, print | ||||
| usage information when any erroneous option is specified. Follow the NetBSD | ||||
| style guide for the usage text’s output format [1]. | ||||
| style guide for the usage text’s output format [0]. | ||||
| 
 | ||||
| [1] <http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/share/misc/style> | ||||
| 
 | ||||
| If committing a new source file, format the commit message following these | ||||
| guidelines: | ||||
| Committing | ||||
| ========== | ||||
| 
 | ||||
| When contributing to Bonsai, please sign your commit with a PGP key and create | ||||
| the commit with an identity which can be easily contacted. | ||||
| 
 | ||||
| Format commit messages following these guidelines: | ||||
| 
 | ||||
| $ git commit -m 'tool(1): add feature x' | ||||
| 
 | ||||
| @ -130,6 +141,13 @@ $ git commit -m 'tool(1): fix #42 & add feature x' | ||||
| 
 | ||||
| Commit messages should be written in the present tense. | ||||
| 
 | ||||
| 
 | ||||
| References | ||||
| ========== | ||||
| 
 | ||||
| [0] <http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/share/misc/style> | ||||
| 
 | ||||
| 
 | ||||
| -- | ||||
| This work © 2023–2024 by Emma Tebibyte is licensed under CC BY-SA 4.0. To view a | ||||
| copy of this license, visit <http://creativecommons.org/licenses/by-sa/4.0/> | ||||
|  | ||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user