43 lines
828 B
Markdown
43 lines
828 B
Markdown
|
---
|
||
|
post_title: Formatting for Changelog.txt
|
||
|
menu_title: Changelog.txt
|
||
|
---
|
||
|
|
||
|
## The Changelog.txt file
|
||
|
|
||
|
WooCommerce extensions use a standard changelog format. Your `changelog.txt` file should look like this:
|
||
|
|
||
|
```php
|
||
|
*** WooCommerce Extension Name Changelog ***
|
||
|
|
||
|
YYYY-MM-DD - version 1.1.0
|
||
|
* Added - Useful new feature
|
||
|
* Fixed - Important bug fix
|
||
|
|
||
|
YYYY-MM-DD - version 1.0.1
|
||
|
* Fixed a bug
|
||
|
|
||
|
YYYY-MM-DD - version 1.0.0
|
||
|
* Initial release
|
||
|
```
|
||
|
|
||
|
## Changelog Entry Types
|
||
|
|
||
|
To showcase the different types of work done in a product update, use any of the following words to denote what type of change each line is:
|
||
|
|
||
|
- add
|
||
|
- added
|
||
|
- feature
|
||
|
- new
|
||
|
- developer
|
||
|
- dev
|
||
|
- tweak
|
||
|
- changed
|
||
|
- update
|
||
|
- delete
|
||
|
- remove
|
||
|
- fixed
|
||
|
- fix
|
||
|
|
||
|
![Example changelog as shown on WooCommerce.com](https://woocommerce.com/wp-content/uploads/2023/12/image-9.png)
|