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
This commit is contained in:
stephffuller 2020-08-12 17:46:12 -04:00 committed by GitHub
parent 310327e6c7
commit 0b6bdd9006
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.github/CONTRIBUTING.md vendored
View File

@ -6,6 +6,7 @@ Hi! We're really excited that you are interested in contributing to ReDoc. Befor
- [Pull Request Guidelines](#pull-request-guidelines) - [Pull Request Guidelines](#pull-request-guidelines)
- [Development Setup](#development-setup) - [Development Setup](#development-setup)
- [Project Structure](#project-structure) - [Project Structure](#project-structure)
- [Style Guide](#style-guide)
## 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 doesn’t already exist.
@ -94,3 +95,7 @@ There are some other scripts available in the `scripts` section of the `package.
- **`src/utils`**: utility functions - **`src/utils`**: utility functions
- **`src/styled-components.ts`**: - reexports styled-components with proper typescript annotations using theme - **`src/styled-components.ts`**: - reexports styled-components with proper typescript annotations using theme
- **`src/theme.ts`**: - default theme (colors, fonts, etc) used by all the components - **`src/theme.ts`**: - default theme (colors, fonts, etc) used by all the components
## Style Guide
Please find our style-guide [here](/style-guide).