Skip to content

Latest commit

 

History

History
67 lines (47 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

67 lines (47 loc) · 1.94 KB

Contributing

When contributing always follow this pipeline.

stateDiagram-v2
    direction LR
    
    [*] --> Issue
    Issue --> Code
    Code --> PR
    PR --> Feedback
    Feedback --> Feedback
    Feedback --> Deny
    Deny --> [*]
    Feedback --> Approval
    Approval --> Merge
    Merge --> Release
    Release --> [*]
Loading

Commits

Commits messages should always be descriptive. Meaning technical descriptions without personal believes or feelings. Commits should always include any of these prefixes:

Prefix Use case
docs: The commit includes documentation update.
feat: The commit includes new features to the project.
fix: The commit includes fixes for existing bugs.
[skip ci] PREFIX: Reserved for CI/CD pipelines. Should never be used by a human.

Commits should only contain changes related to the prefix used, for example: Never commit feat files with docs files.

Commit examples:

fix: fixed login UI by adding username and password inputs

docs: Documentation for deploying the SQL database

A recommendation is to search for the already existing commits in a repository.

Issues

For issues names follow the same instructions of the Commits section.

Describing issues should follow the issue template for each repository

Pull Requests

For PR names follow the same instructions of the Commits section.

  • PR should always be created with existing Opened issues.
  • PR description should point all the changes made by the devs.

Code

Code should always follow this rules:

  • Code should always be descriptive
  • No cryptic variables names.
  • Always use descriptive technical names.
  • Always comment complex code.