forked from swagger-api/swagger-editor
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
35 additions
and
3 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,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)). |
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 |
---|---|---|
@@ -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** |
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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
**UI changes screenshots** | ||
<Please provide screenshot of UI changes in this pull request> | ||
|
||
**Browsers I manually tested this feature in** | ||
* [ ] Google Chrome | ||
* [ ] Firefox | ||
* [ ] Microsoft Edge |