Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
aefhm committed Oct 17, 2023
1 parent 12ce9bc commit 935c121
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 6 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/publish.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ name: publish
on:
push:
tags:
- clients/js/[0-9].[0-9]+.[0-9]+
- contracts/[0-9].[0-9]+.[0-9]+
- integrations/hardhat/[0-9].[0-9]+.[0-9]+
- clients/js/v[0-9].[0-9]+.[0-9]+
- contracts/v[0-9].[0-9]+.[0-9]+
- integrations/hardhat/v[0-9].[0-9]+.[0-9]+

jobs:
publish:
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,9 @@ if the issue is not reported yet, [file a new one].

## Development

### Building and Testing
### Building

Building and testing are documented in our
Building documentation lies at the top-level
[README](https://github.com/oasisprotocol/sapphire-paratime/blob/main/README.md).

### Contributing Code
Expand Down
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,15 @@ development environments
- [`runtime`](./runtime/): the Sapphire Paratime as based off of the
[Oasis SDK](https://github.com/oasisprotocol/oasis-sdk)

## Release

### Clients

JS libraries should be updated with a version bump in the `package.json`
file and a respective tag in the pattern of `{{path}}/v{{semver}}`, such as
`clients/js/v1.1.1`.


## Contributing

Developers are encouraged to contribute their improvements to the Sapphire
Expand All @@ -47,4 +56,4 @@ See our [Contributing Guidelines](CONTRIBUTING.md).
Oasis remains committed to unlocking the full potential of privacy applications
on Web3.

Join the [Privacy4Web3 Hackathon](https://oasisprotocol.org/p4w3-hackathon) today!
Build with [us](https://oasisprotocol.org/opl#how-to-get-started) today!

0 comments on commit 935c121

Please sign in to comment.