Contribution guidelines

[AymKh]

The following thread talks about some of the guidelines and best practices that have to be taken into consideration when pushing commits to this organization.

Table of Contents

• Version Control
• Front End
• Back End Practices
  • Base Entity
  • Default Value

🐙 Version Control

Here are some basic guidelines to keep in mind related to version control practices

• Make sure your branch name follows this notation
  • Bug Fix: fix/BUG_NAME
  • Feature: feat/FEATURE_NAME
  • Chore: chore/CLEANUP_TARGET
• When committing changes to your branch, please use the following prefixes in the commit messages
  • feat: what feature are you adding
  • fix: what bug are you fixing
  • chore: cleanup/restructure done to the project
  • WIP: what are you working on (this is used when you're features spans across multiple commits)
• Always create a PR that best describes your changes
  • Include a meaningful description to your PR explaining what will be added/fixed
  • Include @AymKh as reviewer (please avoid self-merging your own PRs)
  • Assign yourself to your created PR
  • Add appropriate label(s)

👨‍💻 Front End

Here are some basic guidelines to keep in mind while working on any front-end-related code for Planifi

• Use url to manage state as much as possible (query strings)
• Use separate routing object to map internal routes
• Use separate routing objects to map back-end endpoints for each service
• Use rxjs best practices to avoid memory leaks
• Use local variables to hold UI elements for cleaner template (sidebar content, links, sections, ...)
• Use ng-container for all structural directives

🤖 Back End practices

Here are some basic guidelines to keep in mind while working on any back-end-related code for Planifi

👉️ Base Entity

All models MUST extend one base_entity that has the common attributes

• id
• ceated_at
• updated_at

👉️ Default value

Every single attribute of any given model MUST contain a default value.
Initial DB seed must not contain any NULL values.

🙅‍♂️ Things to avoid

• Working on a feature/fix silently, without notifying or updating project on GitHub
• Stacking different fixes/features into one branch
• Installing and using third party packages without discussing with the team first
• Implementing a large chunk of code with zero to none documentation
• Applying changes to core logic without prior discussion ⚠️