-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: provide steps for updating and releasing this SDK (#70)
Once a team is onboarded to this SDK, it is expected that they will be responsible for keeping the code for their service up-to-date. We didn't have documentation to tell them how to do that; this adds those docs.
- Loading branch information
Showing
2 changed files
with
25 additions
and
5 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,20 +1,19 @@ | ||
## Hello Contributors! | ||
Thx for your interest! We're so glad you're here. | ||
|
||
### Important Resources | ||
- bugs: [https://github.com/equinix/equinix-sdk-go/issues](https://github.com/equinix/metal/issues) | ||
|
||
### Code of Conduct | ||
Available via [https://github.com/equinix/equinix-sdk-go/blob/master/.github/CODE_OF_CONDUCT.md](https://github.com/equinix/metal/blob/master/.github/CODE_OF_CONDUCT.md) | ||
|
||
### Environment Details | ||
[https://github.com/equinix/equinix-sdk-go/blob/master/Makefile](https://github.com/equinix/equinix-sdk-go/blob/master/Makefile) | ||
|
||
### How to Submit Change Requests | ||
|
||
Please submit change requests and / or features via [Issues](https://github.com/equinix/equinix-sdk-go/issues). There's no guarantee it'll be changed, but you never know until you try. We'll try to add comments as soon as possible, though. | ||
|
||
#### Pull Requests | ||
All command changes must be reflected in the documentation, this includes new commands and changes to options. The documentation is generated via `make generate-docs`. | ||
|
||
The code in this repo is largely generated from OpenAPI specifications for Equinix APIs. In general, we anticipate that updates to these specifications will come from automation or from Equinix employees. Pull Requests that modify tooling such as `make` tasks, generator versions, or generator configuration, must also include any updates to the generated code. | ||
|
||
### How to Report a Bug | ||
Bugs are problems in code, in the functionality of an application or in its UI design; you can submit them through [Issues](https://github.com/equinix/equinix-sdk-go/issues) as well. |
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