Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2025-08-08 14:14:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source 
Expand issue reporting guidelines with a link to the FAQ and advice for sharing code/spec samples.
This commit is contained in:
Ivana Isadora Devcic 2020-08-17 17:02:14 +02:00 committed by GitHub
parent 8e5a5e8a83
commit 872ccc9b4e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/CONTRIBUTING.md vendored
View File

@ -8,8 +8,10 @@ Hi! We're really excited that you are interested in contributing to ReDoc. Befor
- [Project Structure](#project-structure) - [Project Structure](#project-structure)
## Issue Reporting Guidelines ## Issue Reporting Guidelines
- Before filing a new issue, try to make sure your problem doesn’t already exist. - Before filing a new issue, try to make sure your problem hasn't already been reported. Check our [FAQ](https://github.com/Redocly/redoc/blob/master/FAQ.md) for a list of common questions and problems.
- When describing your issue, let us know which version of ReDoc you are using.
- The best way to get your bug fixed is to provide a reduced test case. - The best way to get your bug fixed is to provide a reduced test case.
- We recommend sharing lengthy code and spec examples [in a gist](https://gist.github.com/) instead of pasting them directly into the issue description or comments. This makes the discussions more readable and easier to follow.
## Pull Request Guidelines ## Pull Request Guidelines
Before submitting a pull request, please make sure the following is done: Before submitting a pull request, please make sure the following is done: