mirror of
				https://github.com/sharkdp/bat.git
				synced 2025-10-31 15:12:12 +00:00 
			
		
		
		
	From a TODO in #1211. Add documentation for contributors.
This changes the README file and adds a new section `Contributors`. This section includes instructions to remind contributors to make an update to the changelog.
This commit is contained in:
		
				
					committed by
					
						 David Peter
						David Peter
					
				
			
			
				
	
			
			
			
						parent
						
							dade4cc6f3
						
					
				
				
					commit
					49d7bf8c39
				
			
							
								
								
									
										16
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										16
									
								
								README.md
									
									
									
									
									
								
							| @@ -676,6 +676,22 @@ bash assets/create.sh | |||||||
| cargo install --path . --locked --force | cargo install --path . --locked --force | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
|  | ## Contributors | ||||||
|  |  | ||||||
|  | Please don't forget to update `CHANGELOG.md` and describe your changes, this makes the release of a new `bat` version much easier. | ||||||
|  |  | ||||||
|  | Each entry should follow the next format: | ||||||
|  | - Short description of the change (one line) | ||||||
|  | - Number of the pull request | ||||||
|  | - Github's username | ||||||
|  |  | ||||||
|  | See the next examples taken from `CHANGELOG.md` | ||||||
|  | ``` | ||||||
|  | - Added support for the `NO_COLOR` environment variable, see #1021 and #1031 (@eth-p) | ||||||
|  | - Adjust pager configuration to comply with `--wrap=never`, see #1255 (@gahag) | ||||||
|  | - Fixed non-printable characters display for redirected output, see #1061 (@gsomix) | ||||||
|  | ``` | ||||||
|  |  | ||||||
| ## Maintainers | ## Maintainers | ||||||
|  |  | ||||||
| - [sharkdp](https://github.com/sharkdp) | - [sharkdp](https://github.com/sharkdp) | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user