Skip to content

Commit 878db7b

Browse files
committed
Added contribution doc
1 parent fc1d75b commit 878db7b

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contribution Guideline
2+
3+
Please make sure your code matching with the ESLint rules and prettier
4+
rules by running the commands `npm run all:lint:check` and `npm run
5+
all:prettier;check`. Otherwise run the
6+
`npm run all:lint:fix` and `npm run all:prettier:fix` commands to fix
7+
automatically fixable issues. Fix other issues manually.
8+
9+
## Project Structure
10+
11+
This project contains two libraries and 3 example projects.
12+
13+
- `packages/google-analytics-embed-react`:- React library
14+
- `packages/google-analytics-embed-types`:- Type definitions library
15+
- `sites/express-backend`:- ExpressJS server which providing the Google
16+
Backend authentication
17+
- `sites/react-backend-auth`:- ReactJS example project which showing the
18+
backend authentication.
19+
- `sites/react-frontend-auth`:- ReactJS example project which showing
20+
the frontend authentication.
21+
22+
Please check the whether both examples working before submitting a PR.

0 commit comments

Comments
 (0)