-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
27 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,12 @@ | ||
| # Contributing Guidelines | ||
|
|
||
| ## Issue tracker | ||
|
|
||
| Our [issue tracker](https://github.com/cs3org/OCM-API/issues) can be used to discuss problems or additions to the current or next version of the Open Cloud Mesh API specification. | ||
|
|
||
| Please follow these guidelines before opening an issue: | ||
|
|
||
| * Make sure your issue is not a duplicate. | ||
| * Make sure your issue is relevant to the specification. | ||
|
|
||
| To stage the changes of your PR, you can change the repo and branch in the URL. | ||
| For instance to see the proposed changes of https://github.com/cs3org/OCM-API/pull/41, use: | ||
| [https://cs3org.github.io/OCM-API/docs.html?branch=add-endpoint-to-accept-invite&repo=OCM-API&user=LovisaLugnegard](https://cs3org.github.io/OCM-API/docs.html?branch=add-endpoint-to-accept-invite&repo=OCM-API&user=LovisaLugnegard) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # Open Cloud Mesh Protocol Specification | ||
|
|
||
|  | ||
|
|
||
| This repository contains the text of the Open Cloud Mesh IETF Draft, as well as the equivalent [OpenAPI](https://github.com/OAI/OpenAPI-Specification) (fka Swagger) specification for its API, which can be rendered as HTML documentation using [ReDoc](https://github.com/Redocly/redoc). | ||
|
|
||
| The documents are available as follows: | ||
|
|
||
| * Current version under development: [RFC-formatted Draft](IETF-RFC.md) | [API spec](https://cs3org.github.io/OCM-API/docs.html?branch=develop&repo=OCM-API&user=cs3org) | ||
| * Version 1.1: [README](https://github.com/cs3org/OCM-API/blob/v1.1.0/README.md) | [API spec](https://cs3org.github.io/OCM-API/docs.html?branch=v1.1.0&repo=OCM-API&user=cs3org) | ||
| * Version 1.0: [API spec](https://cs3org.github.io/OCM-API/docs.html?branch=v1.0.0&repo=OCM-API&user=cs3org) | ||
|
|
||
| [SemVer](https://semver.org) versioning applies to OCM, and all versions are supported unless stated otherwise by an implementation. | ||
|
|
||
| ## Contributing | ||
|
|
||
| The Open Cloud Mesh API specification is an open source, community-driven project. The project is hosted as a [W3C Community Group](https://www.w3.org/community/ocm/). | ||
|
|
||
| If you'd like to contribute, please follow the [Contributing Guidelines](CONTRIBUTING.md). | ||
|
|
||
| ## Changelog | ||
|
|
||
| [Available here](CHANGELOG.md) |