Skip to content
This repository was archived by the owner on Aug 22, 2024. It is now read-only.

Commit 39fac0e

Browse files
authored
Merge pull request #78 from amardeshbd/CONTRIBUTING-README-MD
[ADDED] Contribution guideline
2 parents e6d0da3 + 100ff47 commit 39fac0e

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Contribution Guideline
2+
=====================
3+
4+
You are more than welcome to enhance, fix any demo you see in the app. A good way to start is look into existing [issues](https://github.com/amardeshbd/android-constraint-layout-cheatsheet/issues) and see
5+
if any of them interests you.
6+
7+
Development Guide
8+
----------------------
9+
It is important to keep consistency in the project. Here are some of the key things you need to keep in mind:
10+
11+
* Follow existing app architecture for previewing demo
12+
* Use `LayoutPreviewBaseActivity` if the demo does not need special user interaction
13+
* or, Create subclass of `LayoutPreviewBaseActivity` with user interaction specific binding. See `LayoutVisibilityGoneActivity` as an example.
14+
* Follow existing resource naming convention. See [README](https://github.com/amardeshbd/android-constraint-layout-cheatsheet/blob/master/app/src/main/res/layout/.README.md)
15+
* Create vector assets and save it to [raw resources](https://github.com/amardeshbd/android-constraint-layout-cheatsheet/tree/master/resources/vector) for later use. See [README](https://github.com/amardeshbd/android-constraint-layout-cheatsheet/blob/master/resources/vector/README.md) for example resource and how to create new resource.

0 commit comments

Comments
 (0)