Update README.md

Author: Spikes-2212

README.md

@@ -1,8 +1,52 @@
-# Plain Robot Template
-
-This template is an extension of the WPILib CommandRobot template.<br>
-The extra features of this template are:
-* SpikesLib2, CTRE Phoenix and REVLib vendordeps are added by default.
-* Removal of the example commands and classes WPILib creates by default.
-* A robot map with CAN, DIO, PWM and AIN interfaces.
-* Most importantly, this template includes a Meguvalded OI™ <sub>(patent pending)</sub>. 
+# Crescendo 2024
+
+This is the official code of team Spikes#2212 for the 2024 FRC season.
+
+## Code Conventions
+
+#### General
+
+1. This project is developed according to our java code style convention,
+   described [here](https://docs.google.com/document/d/1rGkyMf1XVvJ3K8mu5f1Gea2YFeEx2MpBVQo05D9ZVtY/edit?usp=sharing).
+2. Each branch is named in `lower-case`, according to the convention `author-feature`.
+3. Commit messages are written in `lower case`.
+
+#### Development
+
+#### Code Conventions
+
+All code in this project should be written according to the following conventions, code would not be merged in case it
+doesn't.
+
+1. All classes should be written in the following order
+    1. Constants Values
+    2. Class Members
+    3. Singleton Initialization
+    4. Constructor
+    5. Methods
+2. All `Namespace` instances should be named in `lower case`.
+
+#### Component Naming Conventions
+
+1. All CANBus components should be named in `lowerCamelCase` according to the following convention -
+   `sideController \ index`
+2. All ports in RobotMap should be named in `ALL_CAPS` according to the following convention `SUBSYSTEM_COMPONENT_INDEX`
+
+##### Feature Branches
+
+This code is developed using the feature branches workflow.
+
+Each feature is developed inside its own branch, which is merged into dev after CR and testing.
+
+##### Testing
+
+Each feature branch should be forked by a `feature-testing` branch, in which all necessary testing code is
+added. <br>
+all the code fixes should be committed into this branch.
+
+After the code passes testing all the commits from the `-testing` are merged with the feature branch.
+
+##### DEV Branch
+
+All feature branches that passed testing successfully are later merged into the `dev` branch, which is in turn merged
+into `master` after passing complete testing and integration.