diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..9af7295f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# Introduction + +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: + +* `thousandeyes-sdk-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-python/issues) here on GitHub. \ No newline at end of file diff --git a/README.md b/README.md index ea8efea8..c59ebe17 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,8 @@ Each of the APIs being published include a README file with instruction on how t ## Contributing -These APIs have been automatically generated by the [OpenAPI Generator](https://openapi-generator.tech/). Hence, we do not accept contributions. +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-python/issues) here on GitHub. \ No newline at end of file +This library is distributed under the Apache 2.0 license found in the [LICENSE](/LICENSE) file. \ No newline at end of file