- PR namin convention : # ticket no. | ticket title
- PRs must have clear decsriptions/change list
- Use atomic commit. What is atomic-git-commits ?
- Remove dead/unused and additional commented code.
- Write impactful comments in your code, don't write redundant and unnecessary comment. Don't explain 'what the code does line by line' instead wrtie 'why this code exists'. Regular epxressions are exception explain your regex clearly.
- Variable naming: Give concise and just enough decriptive variable names, don't name variable too long to make them descriptive. Use the variable naming best practices in the language you are working for eg: python - snake_case and javascirpt - camelCase.
- Write simple and readable code.
- Be consistent in your implementations
- Follow our style guidelines
- use
rem
( border radius are exception ) - typoghraphy ( aviod giving font styles, just use relevant classes )
- color libs
- use BEM
- use
- Declare constant variable in
constant
file, simple rule is when using same data in different place put that intoconstant
file so that when we change the data we only required to update that in one place. - Before declaring resuable funcitons check if that function exists in helpers/utility files. Declare reusable and generic function in helpers/utility files.
- To work on a new task or a ticket
- switch to
dev
branch - take pull
git pull
- create new branch and work on that branch
- switch to
- Avoid using
any
in typescript - Before rasing the PR always make build using
yarn run build
or check with the repo maintainer for thebuild
cmd. - If a project uses
yarn
, it must only containyarn.lock
; if a project usesnpm
, it must only containpackage-lock.json
. Both files can't exists in a project at the same time.
-
Notifications
You must be signed in to change notification settings - Fork 0
himansh-gjr/prerequisites-for-pull-requests
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
About
No description, website, or topics provided.
Resources
Stars
Watchers
Forks
Releases
No releases published
Packages 0
No packages published