Index:

1. Introduction
2. Stack
   
3. Rules
   a. About Tasks & Chart
   a. About Branches
   b. About Commits
   c. About Pull Requests
   d. About Merge Conflicts
   e. About Variables
   f. About New Modules
   

Introduction

Stack

-Javascript
-React
-Firebase

Rules

Rules about Tasks & Chart:

When you get a new task, and you start doing it, you need to follow the next steps:

1. create a branch
2. put the task in jira to In Progress state.
3. make all the code you need to fulfill the requirementes, for more info about this
4. when you think that the task is done, make all the necessary commits/push and then, go back to github, and in the upper tab, go to Pull Requests
5. when you are in that tab, you can create the Pull Request
6. then, put the task to Code Review state.
7. wait for Santiago Riveros to review your pull request (You can reach out if this step takes a lot of time)
8. when that developer merges your code, he is responsible to put your task in Jira to Done state.

Rules about Branches:

All branches must match his name with an specific task-card of the project in Jira.
All must match this format ACC3-{Number of the task}.

Rules about Commits:

All commits must intend to be minimal, with no more of 100 lines of code. (Also, you can make a lot of commits on the same branch, is better have little commits to review it better)
All commits must follow the next Format {Performed Action} + {The site itself of the changes or the name of the file} + {details}
All commits must be in English, you can use a translator.

Rules about Pull Request:

You never, never, never, make a change directly to main Branch, you can also, make a PR of your task branch to main.
Never merge your own PR, Santiago Riveros will need to review it and merge it.
Try to make a PR with a title that matches the nature of the task itself, if you can't find the words to make it, you can simply put the task code, or the branch name.

Rules about Merge Conflicts:

In case of merge conflict, notify the owner of the pull request, it is their responsibility to solve the conflict, once they have solved it, they can notify you so that the pull request can be merged.

Rules about Variables:

All of the variables in the project, must use camelCase, and all of them must be in English.
Its better to have a long variable name but, with a descriptive name like var anotherUnnecesaryAndWeirdWithNoSenseVariable = "" than var varA = "". Try to avoid misspellings in the variable name.

Rules about installing new modules:

You can install new dependencies, to do that, simply reach out [@SantiagoRiveros] (https://www.github.com/SantiagoRiveros) (or simply email him to santiagoriverosjasis@gmail.com) to notify all of the dev team, and to make sure we are creating a consistent project.