Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: README trim and getting started guide #104

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

docs: README trim and getting started guide #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
64b337b
docs: trim README
AndyTWF Feb 20, 2025
b027b92
docs: add getting started guide to README
AndyTWF Feb 20, 2025
6bf8b3f
docs: add explicit docs section in README
AndyTWF Feb 21, 2025
308ba6f
contributing: add docs information to guide
AndyTWF Feb 21, 2025
4984a07
update docs step in contributing.md
AndyTWF Feb 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 16 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,14 @@ In the project where you want to use the updated library:
> - The `mavenLocal()` repository should typically be used only during development to avoid conflicts with published versions in remote
repositories.

## Documentation

The source of truth for documentation for the Ably Chat SDKs can be found on the [Ably Docs repository](https://github.com/ably/docs).

Please ensure that you merge any pull requests in that repository promptly after releasing your change.

Any releases must be accompanied by a PR to bump the library install version in the setup/install guide, at minimum.

## Release Process

### Prerequisites for Release
Expand Down Expand Up @@ -147,9 +155,10 @@ This library uses [semantic versioning](http://semver.org/). For each release, t
- Also ensure that the "Full Changelog" link points to the new version tag instead of the `HEAD`.

4. Commit [CHANGELOG](./CHANGELOG.md)
5. Make a PR against `main`
6. Once the PR is approved, merge it into `main`
7. From the updated `main` branch on your local workstation, assemble and upload:
5. Create a PR on the [website docs](https://github.com/ably/docs) that updates that SDK version in the setup/installation guide.
6. Make a PR against `main`
7. Once the PR is approved, merge it into `main`
8. From the updated `main` branch on your local workstation, assemble and upload:
```sh
./gradlew publishAndReleaseToMavenCentral
```
Expand All @@ -159,6 +168,7 @@ This library uses [semantic versioning](http://semver.org/). For each release, t
- Missing POM file information
- Invalid signatures
- Incomplete Javadoc
8. Add a tag and push to origin - e.g.: `git tag v1.2.4 && git push origin v1.2.4`
9. Create the release on Github including populating the release notes
10. Create the entry on the [Ably Changelog](https://changelog.ably.com/) (via [headwayapp](https://headwayapp.co/))
9. Add a tag and push to origin - e.g.: `git tag v1.2.4 && git push origin v1.2.4`
10. Create the release on Github including populating the release notes
11. Merge any [website docs](https://github.com/ably/docs) PRs related to the changes, including the one you created in Step 5.
12. Create the entry on the [Ably Changelog](https://changelog.ably.com/) (via [headwayapp](https://headwayapp.co/))
Loading
Loading