Skip to content

Commit e1cec80

Browse files
committed
README.md: move the publishing section to a new CONTRIBUTING.md doc
1 parent b7577b0 commit e1cec80

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

CONTRIBUTING.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Contributing to React Async Renderer
2+
3+
## Publishing
4+
5+
1. Create a new branch with change log updates and a version bump under the `release/` namespace (e.g. `release/v1.2.1`).
6+
2. Create a pull request and merge that new branch into the `main` branch.
7+
3. [Publish a new Github release](https://docs.github.com/en/enterprise-cloud@latest/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release) with a new release tag off of the merge commit of your release. Use the format `v<package.json version number>`, e.g. v1.2.1.
8+
4. Use the GitHub tool to generate the release notes.
9+
5. Rename "Full Changelog" to "Commit Changelog".
10+
6. On a new line, add "**Full Changelog**: `https://github.com/MFB-Technologies-Inc/react-async-renderer/blob/<new tag>/CHANGELOG.md`", replacing `<new tag>` with the tag for this release.
11+
12+
> Publishing a new Github release will trigger the publish Github action, which publishes the new release to NPM.

README.md

-12
Original file line numberDiff line numberDiff line change
@@ -86,18 +86,6 @@ These other utility functions can be used to simplify the logic around `createAs
8686
- `getCascadedAsyncState`: Reduces a chain of asynchronous request objects down one asynchronous request object.
8787
- `getOptimisticAsyncLoadState`: Converts its arguments into an optimistic asynchronous request object such that if the arguments indicate a pending asynchronous request and a fulfilled asynchronous request, then the result is a fulfilled asynchronous request object.
8888

89-
## Publishing
90-
91-
1. Create a new branch with change log updates and a version bump.
92-
2. Create a pull request and merge that new branch into the `main` branch.
93-
3. [Publish a new Github release](https://docs.github.com/en/enterprise-cloud@latest/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release) with a new release tag off of the `main` branch. Use the format `v<package.json version number>`, e.g. v1.2.1.
94-
95-
> Publishing a new Github release will trigger a Github action to publish the new release to NPM.
96-
97-
4. Use the GitHub tool to generate the release notes.
98-
5. Rename "Full Changelog" to "Commit Changelog"
99-
6. On a new line, add "**Full Changelog**: `https://github.com/MFB-Technologies-Inc/react-async-renderer/blob/<new tag>/CHANGELOG.md`", replacing `<new tag>` with the tag for this release.
100-
10189
## Changelog
10290

10391
[Changelog](./CHANGELOG.md)

0 commit comments

Comments
 (0)