-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
51 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# CONTRIBUTING | ||
|
||
## Code | ||
|
||
Your code MUST follow the repository's eslint configuration (run nx lint before committing) | ||
|
||
## Commit messages | ||
|
||
MUST be in english | ||
|
||
MUST describe what has been done in the code briefly | ||
|
||
MUST be in imperative mood (ie: Add contributing guidelines) | ||
|
||
## Structure | ||
|
||
### Controller structure (example with DemoController) | ||
- Controller file location: src/controllers/demo/demo.controller.ts | ||
- Test file location: src/controllers/demo/demo.controller.spec.ts | ||
|
||
### Service structure (example with VideoEditorService) | ||
- Service file location: src/services/video-editor/video-editor.service.ts | ||
- Test file location: src/services/video-editor/video-editor.service.spec.ts | ||
|
||
## Testing | ||
|
||
Unit tests are located in a .spec.ts file in their component or service folder | ||
|
||
e2e tests are located in the test/ folder | ||
|
||
## API Routes | ||
|
||
MUST be in a controller | ||
|
||
MUST be stateless | ||
|
||
MUST use the correct http verb for its action | ||
https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods | ||
|
||
MUST reply with the most accurate HTTP code | ||
https://developer.mozilla.org/en-US/docs/Web/HTTP/Status | ||
|
||
## Pull Requests | ||
|
||
MUST only add ONE feature | ||
|
||
SHOULD be as small as possible | ||
|
||
MUST be approved by at least one of the code owners | ||
|
||
SHOULD be approved by at least two developers |