Release preparation including some renaming and some additional files #6
Conversation
This file contains hidden or 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
peterkellydev
force-pushed
the
release-prep
branch
from
33636c6 to
f993602
Compare
pleshakov
suggested changes
Jul 31, 2018
CONTRIBUTING.md
Outdated
| @@ -0,0 +1,138 @@ | |||
| # Contributing Guidelines | |||
|
|
|||
| The following is a set of guidelines for contributing to the NGINX AWS Auto-Scale Group Sync tool. We really appreciate that you are considering contributing! | |||
There was a problem hiding this comment.
NGINX AWS Auto-Scale Group Sync tool -> NGINX Plus Golang SDK !
There was a problem hiding this comment.
Good catch, btw @pleshakov you need to stop referring to Go as Golang everywhere. That is against the naming guidelines of the Go project, it is just "Go"
CONTRIBUTING.md
Outdated
|
|
||
| ## Getting Started | ||
|
|
||
| Read the usage and testing steps in the [README](https://github.com/nginxinc/nginx-plus-go-sdk/blob/master/README.md). |
CONTRIBUTING.md
Outdated
| ### Open a Pull Request | ||
|
|
||
| * Fork the repo, create a branch, submit a PR when your changes are tested and ready for review | ||
| * You will be asked to fill in [our pull request template](https://github.com/nginxinc/nginx-plus-go-sdk/blob/master/.github/PULL_REQUEST_TEMPLATE.md) |
There was a problem hiding this comment.
why not a relative link?
|
|
||
| ## Using the SDK | ||
|
|
||
| For now, copy `client/nginx_client.go` into your go project. | ||
| 1. Import `github.com/nginxinc/nginx-plus-go-sdk/client` into your go project. | ||
| 2. Use your favourite vendor tool to add this to your `/vendor` directory in your project. |
There was a problem hiding this comment.
Perhaps it is worth including a simple example? We can use the demo.nginx.com instance in that example.
|
|
||
| ## Testing | ||
|
|
||
| ### Unit tests | ||
| ``` |
There was a problem hiding this comment.
please use $ in shell commands, such as $ make clean
README.md
Outdated
|
|
||
| This will build and run an NGINX Plus container, execute the SDK tests against NGINX Plus API, and then clean up: |
There was a problem hiding this comment.
make a note that if the test fail, to remove the container, you need to run $ make clean
- Some file renaming - Addition of open source documentation - Improve README and Makefile
peterkellydev
force-pushed
the
release-prep
branch
from
f993602 to
a622b0c
Compare
pleshakov
suggested changes
Aug 3, 2018
LICENSE
Outdated
| same "printed page" as the copyright notice for easier | ||
| identification within third-party archives. | ||
|
|
||
| Copyright 2016 Nginx, Inc. |
README.md
Outdated
|
|
||
| ## Support | ||
| This project is not covered by the NGINX Plus support contract |
|
|
||
| ``` | ||
| $ make test | ||
| ``` | ||
|
|
| @@ -4,34 +4,36 @@ This SDK includes a client library for working with NGINX Plus API. | |||
|
|
|||
| ## About the SDK | |||
|
|
|||
| `client/nginx_client.go` includes functions and data structures for working with NGINX Plus API as well as some helper functions. | |||
| `client/nginx.go` includes functions and data structures for working with NGINX Plus API as well as some helper functions. | |||
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
isaachawley
approved these changes
Aug 7, 2018
Dean-Coakley
force-pushed
the
release-prep
branch
from
1e13d50 to
0eb5ebf
Compare
Dean-Coakley
force-pushed
the
release-prep
branch
from
0eb5ebf to
3bba948
Compare
pleshakov
approved these changes
Aug 7, 2018
Dean-Coakley
approved these changes
Aug 7, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prepare project for release as open-source