mirror of
https://github.com/git-touch/git-touch
synced 2025-03-04 11:17:47 +01:00
docs: add contributing.md
This commit is contained in:
parent
f4ad7c33b8
commit
1d4dd65b0b
27
CONTRIBUTING.md
Normal file
27
CONTRIBUTING.md
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
# Contributing
|
||||||
|
|
||||||
|
## Repository structure
|
||||||
|
|
||||||
|
```sh
|
||||||
|
lib
|
||||||
|
├── main.dart # App entry
|
||||||
|
├── graphql
|
||||||
|
│ ├── # GraphQL queries
|
||||||
|
├── models
|
||||||
|
│ ├── # Provider models and other JSON models
|
||||||
|
├── router.dart # Routers here
|
||||||
|
├── scaffolds
|
||||||
|
│ ├── # Several scaffolds for reducing boilerplate code
|
||||||
|
├── screens
|
||||||
|
│ ├── gh_xxx.dart # GitHub screens
|
||||||
|
│ ├── bb_xxx.dart # Bitbucket screens
|
||||||
|
│ ├── gl_xxx.dart # GitLab screens
|
||||||
|
│ ├── gt_xxx.dart # Gitea screens
|
||||||
|
│ └── # File with no prefix: common screens
|
||||||
|
├── utils
|
||||||
|
│ ├── # Utilities
|
||||||
|
└── widgets
|
||||||
|
└── # Reusable widgets
|
||||||
|
```
|
||||||
|
|
||||||
|
Feel free to open an issue to discuss it if you get stuck.
|
@ -24,6 +24,10 @@ Android users can also download APK file from [release page](https://github.com/
|
|||||||
<img src="assets/screenshot-light.png" alt="Light screenshot" width="400" />
|
<img src="assets/screenshot-light.png" alt="Light screenshot" width="400" />
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
See [CONTRIBUTING.md](./CONTRIBUTING.md).
|
||||||
|
|
||||||
## Contributors
|
## Contributors
|
||||||
|
|
||||||

|

|
||||||
|
Loading…
x
Reference in New Issue
Block a user