diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 87b4fde8c6d..de6847da732 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,7 +1,19 @@ -# Contributing to Swagger Editor +### Frequent Issues -### Issues -File issues in GitHub's to report bugs or issue a pull request. +**Generated code is not working.** +Report it in [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) repository + +**I see "Code Generation Server is not availabe"** +Either codegen servers are down or [your config](https://github.com/swagger-api/swagger-editor/blob/6dd09e5886c414801fd6eea3bb86bd2a3643c249/config/defaults.json.guide.js#L31) is pointing to an invalid loccation + +**`OPTIONS` call is failing** +See [CORS document](https://github.com/swagger-api/swagger-editor/blob/master/docs/cors.md) + +**How do I store my spec?** +Swagger Editor does not have a backend. + +**I can't start Swagger Editor** +You rarely would need to build Swagger Editor from source. Use one of methods described in README to start a new instance of Swagger Editor. ### Licensing All contributions must grant copyright permission to this project, the source of which is declared to be under an Apache 2 license (see [LICENSE](./LICENSE)). diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000000..e21cb947e60 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,13 @@ +**Note on code generation issues** +Please open an issue in [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) repository for any issue with generating code or issues with generated codes. + +**My Swagger** + +```yaml + # paste your swagger document here +``` + +* Swagger Editor version(from Help > About menu): +* My browser: + +**Issue** diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000000..a7c4c33a16e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,7 @@ +**UI changes screenshots** + + +**Browsers I manually tested this feature in** +* [ ] Google Chrome +* [ ] Firefox +* [ ] Microsoft Edge