Skip to content

Commit

Permalink
CP-1977 Applied some suggestions made by Legal & OSPO (#38)
Browse files Browse the repository at this point in the history
  • Loading branch information
mpragosa-te authored Jun 4, 2024
1 parent e2f4b26 commit f078c0f
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 27 deletions.
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Introduction

These APIs have been automatically generated by the [OpenAPI Generator](https://openapi-generator.tech/).
Hence, we only allow contributions to a few non-autogenerated resources under `core/`.

# Getting started

In case you'd like to submit your contribution, the following steps must be followed:

1. Fork the repository
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

# How to report a bug

If you run into problems using the SDK, you can post [issues](https://github.com/thousandeyes/thousandeyes-sdk-java/issues) here on GitHub.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2024 Cisco ThousandEyes
Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
7 changes: 7 additions & 0 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Copyright 2024 Cisco Systems, Inc. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
30 changes: 4 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,38 +2,16 @@

## Description

`thousandeyes-sdk-java` is a set of Java client libraries for
the [Thousandeyes v7 API](https://developer.cisco.com/docs/thousandeyes/v7/).
`thousandeyes-sdk-java` is a set of Java client libraries for the [Thousandeyes v7 API](https://developer.cisco.com/docs/thousandeyes/v7/).

## Installation and usage

Each of the APIs being published include a README file with instruction on how to install and use
the API.
Each of the APIs being published include a README file with instruction on how to install and use the API.

## Contributing

These APIs have been automatically generated by
the [OpenAPI Generator](https://openapi-generator.tech/). Hence, we only allow contributions to the
following list of non-autogenerated resources under `core/`:

* `authentication`
* `client-native`
* `client`
* `examples`

For these resources, the following steps must be followed:

1. Fork the repository
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
Thanks for your interest in contributing! There are many ways to contribute to this project. Get started [here](/CONTRIBUTING.md).

## License

This library is distributed under the Apache 2.0 license found in the [LICENSE](/LICENSE) file.

## Need help?

If you run into problems using the SDK, you can
post [issues](https://github.com/thousandeyes/thousandeyes-sdk-java/issues) here on GitHub.
This library is distributed under the Apache 2.0 license found in the [LICENSE](/LICENSE) file.

0 comments on commit f078c0f

Please sign in to comment.