plan.md

Phase 1

Supported functionalities

- gits pr_update
- gits profile
- gits rebase
- gits reset
- gits set
- gits upstream
- gits super reset
- gits add
- gits commit
- gits create_branch
- gits logging

The above implemented functionalities are supported only on Linux/Mac operating systems.

Phase 2

Tasks:

1. Improvise the documentation to remove ambiguity.
2. Write clear documentation for all the phase 2 functionalities.
3. Write stepwise instructions to setup the environment.
4. Write unit tests for all the GITS commands.
5. Manually test the functionalities on a dummy repository.
6. Provide code coverage solution to the project.
7. Implement functionalities listed in Functionalities section.
8. Deliver a good repository.

Functionalities:

- gits push 
- gits sync
- gits init
- gits status 
- gits diff
- gits checkout
- gits branch 
- gits unstage

Deliverables:

1. Good testing setup with unit tests and code coverage.
2. Clear and complete documentation
3. Implementation of new functionalities.

Phase 3

Tasks:

1. Improvise the documentation talk about new features clearly.
2. Write clear documentation for all the phase 3 functionalities.
3. Write new features which will benefit users further.
4. Run all test cases before commiting.
5. Manually test the functionalities on a dummy repository.
6. Provide example of outputs
7. Deliver a good repository.

Functionalities:

- gits tag
- gits tag <tag name>
- gits checkout <tag name>
- gits commit_test
- gits commit_tree
- gits stats
- gits decribe

Deliverables:

1. Good setup to view and visualize branches.
2. Clear and complete documentation
3. Implementation of new functionalities.
4. Provide examples and visualization

Phase 4

Tasks and Implementation:

1. Write new features which will benefit users further
2. Improve the quantity and quality of tests
3. Continue to work on documentation for clients of the repo
4. Implement a UI for better user experience
5. Provide example of outputs
6. Deliver a good repository.

Functionalities:

- UI
- gits nickname
- gits alias
- ...

Future Scope:

1. Improve the UI for better user experience
2. Implement a feature in which user alias and settings can be imported and exported across different machines.