Skip to content

Commit 36557f6

Browse files
committed
Formatting
1 parent 9798946 commit 36557f6

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,5 +192,5 @@ repository:
192192

193193
## Releasing
194194

195-
The release are created by the maintainers of the library. The process is documented in
195+
The releases are created by the maintainers of the library. The process is documented in
196196
the [RELEASING.md](RELEASING.md) file.

RELEASING.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Releasing
1+
# Releasing
22

33
The following steps outline the release process for both new minor versions (e.g.
44
releasing the `master` branch as X.Y.0) and patch versions (e.g. releasing the
@@ -13,11 +13,11 @@ It helps to keep your own fork in sync with the "mongodb" repository (i.e. any
1313
branches and tags on the main repository should also exist in your fork). This
1414
is left as an exercise to the reader.
1515

16-
### Ensure PHP version compatibility
16+
## Ensure PHP version compatibility
1717

1818
Ensure that the library test suite completes on supported versions of PHP.
1919

20-
### Transition JIRA issues and version
20+
## Transition JIRA issues and version
2121

2222
All issues associated with the release version should be in the "Closed" state
2323
and have a resolution of "Fixed". Issues with other resolutions (e.g.
@@ -31,7 +31,7 @@ Update the version's release date and status from the
3131
[Manage Versions](https://jira.mongodb.org/plugins/servlet/project-config/PHPLIB/versions)
3232
page.
3333

34-
### Update version info
34+
## Update version info
3535

3636
The PHP library uses [semantic versioning](https://semver.org/). Do not break
3737
backwards compatibility in a non-major release or your users will kill you.
@@ -41,7 +41,7 @@ changes in this maintenance branch. This is important because we will later
4141
merge the ensuing release commits up to master with `--strategy=ours`, which
4242
will ignore changes from the merged commits.
4343

44-
### Update composer.json and CI matrices
44+
## Update composer.json and CI matrices
4545

4646
This is especially important before releasing a new minor version.
4747

@@ -81,7 +81,7 @@ $ git commit -m "Update composer.json and CI matrices for X.Y.Z" composer.json .
8181
$ git push mongodb
8282
```
8383

84-
### Tag the release
84+
## Tag the release
8585

8686
Create a tag for the release and push:
8787

@@ -90,9 +90,9 @@ $ git tag -a -m "Release X.Y.Z" X.Y.Z
9090
$ git push mongodb --tags
9191
```
9292

93-
### Branch management
93+
## Branch management
9494

95-
## Creating a maintenance branch and updating master branch alias
95+
# Creating a maintenance branch and updating master branch alias
9696

9797
After releasing a new major or minor version (e.g. 1.9.0), a maintenance branch
9898
(e.g. v1.9) should be created. Any development towards a patch release (e.g.
@@ -123,7 +123,7 @@ Commit this change:
123123
$ git commit -m "Master is now 1.10-dev" composer.json
124124
```
125125

126-
#### After releasing a new minor version
126+
### After releasing a new minor version
127127

128128
After a new minor version is released (i.e. `master` was tagged), a maintenance
129129
branch should be created for future patch releases:
@@ -151,7 +151,7 @@ $ git commit -m "Master is now X.Y-dev" composer.json
151151
$ git push mongodb
152152
```
153153

154-
#### After releasing a patch version
154+
### After releasing a patch version
155155

156156
If this was a patch release, the maintenance branch must be merged up to master:
157157

@@ -168,7 +168,7 @@ branch was up-to-date with all code changes in this maintenance branch before
168168
tagging.
169169

170170

171-
### Publish release notes
171+
## Publish release notes
172172

173173
The following template should be used for creating GitHub release notes via
174174
[this form](https://github.com/mongodb/mongo-php-library/releases/new).
@@ -212,7 +212,7 @@ Thanks for our community contributors for this release:
212212

213213
Release announcements should also be posted in the [MongoDB Product & Driver Announcements: Driver Releases](https://mongodb.com/community/forums/tags/c/announcements/driver-releases/110/php) forum and shared on Twitter.
214214

215-
### Documentation Updates for New Major and Minor Versions
215+
## Documentation Updates for New Major and Minor Versions
216216

217217
New major and minor releases will also require documentation updates to other
218218
projects:

0 commit comments

Comments
 (0)