Skip to content

Commit e330cbe

Browse files
author
Rafeequl
committed
initial commit
0 parents  commit e330cbe

File tree

4 files changed

+30
-0
lines changed

4 files changed

+30
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# READ ME

coding_style.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Sleekr Style Guide
2+
Styleguide for Sleekr Engineering team
3+
4+
## General Rules
5+
6+
### Readability / Expressiveness Comes First
7+
It's okay if you have many methods or long variable name as long as it's more readable / expressive.
8+
9+
### Keep IT Simple, Stupid / KISS
10+
The KISS principle states that most systems work best if they are kept simple rather than made complicated. If you only use a method or function than you don't need to import whole library.
11+
12+
### Always Follow YAGNI Principle
13+
You aren't gonna need it / YAGNI a principle that states a programmer should not add functionality until deemed necessary. When coding don't think too much about the future feature. Just focus with current feature. It will prevent our code base too complex in early development.
14+
15+
### Don't Forget About Performance
16+
After refactoring or implementing a feature, don't forget to monitor the performance.

definition_of_done.md

Whitespace-only changes.

pr_template.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## What's this PR do ?
2+
## Where should the reviewer start ?
3+
## How should this be manually tested ?
4+
## What is the Dockup URL ?
5+
## Any background context you want to provide ?
6+
## What are the relevant tickets ?
7+
## Screenshots (if appropriate)
8+
## Definition of Done:
9+
- [ ] Does this PR require Database changes ?
10+
- [ ] Does this PR require a regression test by QA ? All fixes require a regression test.
11+
- [ ] Does this add new dependencies? (network setup, new 3rd party services)
12+
- [ ] Will this feature require a new piece of infrastructure to be implemented? (new env variable, new servers etc)
13+
- [ ] Does this PR require new Mixpanel or GA events or Datadog events ?

0 commit comments

Comments
 (0)