mirror of
				https://github.com/sharkdp/bat.git
				synced 2025-10-31 07:04:04 +00:00 
			
		
		
		
	More detailed description for CHANGELOG section
This commit is contained in:
		| @@ -1,13 +1,23 @@ | ||||
| # Contributing | ||||
|  | ||||
| ### Add an entry to the changelog | ||||
| Thank you for considering to contribute to `bat`! | ||||
|  | ||||
| Please don't forget to update [CHANGELOG.md](CHANGELOG.md) and describe your changes (in the "unreleased" section), this makes the release of a new `bat` version much easier. | ||||
|  | ||||
| Each entry should follow the following format: | ||||
|  | ||||
| ## Add an entry to the changelog | ||||
|  | ||||
| If your contribution changes the behavior of `bat` (as opposed to a typo-fix | ||||
| in the documentation), please update the [`CHANGELOG.md`](CHANGELOG.md) file | ||||
| and describe your changes. This makes the release proess much easier and | ||||
| therefore helps to get your changes into a new `bat` release faster. | ||||
|  | ||||
| The top of the `CHANGELOG` contains a *"unreleased"* section with a few | ||||
| subsections (Features, Bugfixes, …). Please add your entry to the subsection | ||||
| that best describes your change | ||||
|  | ||||
| Entries follow this format: | ||||
| ``` | ||||
| - Short description of what has been changed, see #123 (@user) | ||||
| ``` | ||||
|  | ||||
| Where `#123` is your PR's number or ticket and `@user` is you Github's username.  | ||||
|  | ||||
| Here, `#123` is the number of the original issue and/or your pull request. | ||||
| Please replace `@user` by your GitHub username. | ||||
|   | ||||
		Reference in New Issue
	
	Block a user