Skip to content
This repository was archived by the owner on Jun 4, 2025. It is now read-only.

Commit 7099c04

Browse files
authored
Add CHANGELOG.md (#317)
2 parents 940dc96 + 2df80de commit 7099c04

File tree

3 files changed

+54
-1
lines changed

3 files changed

+54
-1
lines changed

.buildkite/pipeline.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Nodes with values to reuse in the pipeline.
22
common_params:
33
plugins: &common_plugins
4-
- &bash_cache automattic/bash-cache#2.8.0
4+
- &bash_cache automattic/bash-cache#2.9.0
55
env: &common_env
66
IMAGE_ID: xcode-14
77

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2+
---
3+
4+
- [ ] I have considered if this change warrants release notes and have added them to the appropriate section in the `CHANGELOG.md` if necessary.

CHANGELOG.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Changelog
2+
3+
The format of this document is inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and the project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
4+
5+
<!-- This is a comment, you won't see it when GitHub renders the Markdown file.
6+
7+
When releasing a new version:
8+
9+
1. Remove any empty section (those with `_None._`)
10+
2. Update the `## Unreleased` header to `## [<version_number>](https://github.com/wordpress-mobile/WordPress-iOS-Shared/releases/tag/<version_number>)`
11+
3. Add a new "Unreleased" section for the next iteration, by copy/pasting the following template:
12+
13+
## Unreleased
14+
15+
### Breaking Changes
16+
17+
_None._
18+
19+
### New Features
20+
21+
_None._
22+
23+
### Bug Fixes
24+
25+
_None._
26+
27+
### Internal Changes
28+
29+
_None._
30+
31+
-->
32+
33+
## Unreleased
34+
35+
### Breaking Changes
36+
37+
_None._
38+
39+
### New Features
40+
41+
_None._
42+
43+
### Bug Fixes
44+
45+
_None._
46+
47+
### Internal Changes
48+
49+
- Add this changelog entry about changelog itself [#317]

0 commit comments

Comments
 (0)