You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+69Lines changed: 69 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,7 @@ Whether it's a bug report, new feature, correction, or additional documentation,
8
8
-[Our Design](#our-design)
9
9
-[Development Process](#development-process)
10
10
-[Setting up for local development](#setting-up-for-local-development)
11
+
-[Setting up git-secrets](#setting-up-git-secrets)
11
12
-[Architecture of the codebase](#architecture-of-the-codebase)
12
13
-[Steps towards contributions](#steps-towards-contributions)
13
14
-[Bug Reports](#bug-reports)
@@ -68,6 +69,74 @@ yarn build
68
69
69
70
> Note: Make sure to always [sync your fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork) with main branch of `amplify-js`
70
71
72
+
## Setting up git-secrets
73
+
74
+
This repository uses [git-secrets](https://github.com/awslabs/git-secrets) to prevent accidentally pushing AWS credentials or other secrets. A pre-push hook will scan your commits before pushing to the remote repository.
Allowed patterns are stored in `.git/config` and apply only to your local repository.
137
+
138
+
> **Note:** The pre-push hook will block pushes if git-secrets is not installed. Please install and configure git-secrets before contributing.
139
+
71
140
## Architecture of the codebase
72
141
73
142
Amplify JS is a monorepo built with `Yarn` and `Lerna`. All the categories of Amplify live within the `packages` directory in the root. Each category inside packages has its own `src/` and `package.json`.
0 commit comments