Work Agreement

All documentation must be written in Spanish. On the other hand, all code must be written in English.

Issues

Workflow

• Gradual review (3 days) for the issues.

Branches

Name convention

Must match with the following conventions:

• It must start with the main purpose of the change,

  • feature: new functionality
  • fix: solves an error
  • setup: installation and/or configuration

• It must end with the issue number,

  • Examples, feature/issue-90 or fix/issue-91

Creation and merge process

• First of all, all branches must use the branch development as a starting point.
• To merge your branch into development, a pull request must be opened with the following:
  1. Title, it could have the issue number.
  2. Description, must be a detailed description of the changes not only the commit messages.
  3. 2 Reviewers, to perform code reviews.
  4. Optional, you can open the pull request as a draft for yourself and perform a code review of your code before publishing it.
• To merge development into stage,
  1. 3 Reviewers must approve change.
• To merge stage into main,
  1. Any maintainer can perform this change at this point.

Technology Stack

Main

• React
• Gatsby

State Management

• Apollo

Style

• Styled components
• Styled system

Static Code Analyzer

• Prettier
• Airbnb - ESLint
• Stylelint

Git Hooks

• Husky

Rules

• pre-commit: prettier & eslint
• pre-push: jest
• post-push: gatsby build

Tests

• Storybook
• Jest
• React testing library

Continuous Integration & Continuous Deployment

• Github Actions
• Amplify

Miscellaneous

• EditorConfig