add CONTRIBUTING.md

This commit is contained in:
Aria Moradi
2021-10-30 18:51:47 +03:30
parent 8ac72a483d
commit ac22bfe9cd
2 changed files with 11 additions and 0 deletions

8
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,8 @@
# Contributing
## Where should I start?
Everything from https://github.com/Suwayomi/Tachidesk-Server/blob/master/CONTRIBUTING.md#where-should-i-start applies here.
## Coding Style Guide
**Note:** Some of the bellow are new, refactor the code to match the style guide where you see discrepancies.
- Don't use relative imports.
- We are using MUI v5, the all stylings must be applied with the new system.

View File

@@ -9,6 +9,9 @@ You can find minified builds of WebUI in [Tachidesk-WebUI-preview](https://githu
# About # About
This is a `create-react-app` project, you can find it's readme in [BUILDING.md](./BUILDING.md) This is a `create-react-app` project, you can find it's readme in [BUILDING.md](./BUILDING.md)
## Contributing and Technical info
See [CONTRIBUTING.md](./CONTRIBUTING.md).
## License ## License
Copyright (C) Contributors to the Suwayomi project Copyright (C) Contributors to the Suwayomi project