Skip to content

Commit 8c549d9

Browse files
authored
Document the release process (#1787)
1 parent da3891c commit 8c549d9

File tree

1 file changed

+25
-8
lines changed

1 file changed

+25
-8
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,36 @@
11
# Contributing to graphql-php
22

3-
## Workflow
3+
## Open a Pull Request
44

55
If your contribution requires significant or breaking changes, or if you plan to propose a major new feature,
66
we recommend you to [create an issue](https://github.com/webonyx/graphql-php/issues/new)
77
with a brief proposal and discuss it with us first.
88

9-
For smaller contributions just use this workflow:
9+
For smaller contributions use this workflow:
1010

11-
- Fork the project.
12-
- Add your features and or bug fixes.
13-
- Add tests to ensure your changes work and will continue working.
14-
- Check your changes using `composer check`.
15-
- Add an entry to the [Changelog's Unreleased section](CHANGELOG.md#unreleased).
16-
- Send a pull request.
11+
1. Fork the project.
12+
2. Add your features and or bug fixes.
13+
3. Add tests to ensure your changes work and will continue working.
14+
4. Check your changes using `composer check`.
15+
5. Add an entry to the [Changelog's Unreleased section](CHANGELOG.md#unreleased).
16+
6. Send a pull request.
17+
18+
## Release a New Version
19+
20+
Before you release a new version, make sure to familiarize yourself with:
21+
22+
- [Keep a Changelog](https://keepachangelog.com/en/1.0.0)
23+
- [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
24+
- [Previous GitHub Releases](https://github.com/webonyx/graphql-php/releases)
25+
26+
To create a new release, follow these steps:
27+
28+
1. Consider the entries in the [`CHANGELOG unreleased section`](CHANGELOG.md#unreleased), add missing entries if needed
29+
2. Based on those entries and the previous version, define the next version number and add it to the [`CHANGELOG.md`](CHANGELOG.md)
30+
3. [Draft a new release](https://github.com/webonyx/graphql-php/releases/new)
31+
4. Add the version number as both tag and title
32+
5. Add the changelog entries as the description
33+
6. Publish the release
1734

1835
## Setup
1936

0 commit comments

Comments
 (0)