Skip to content
Binary file added .coverage
Binary file not shown.
24 changes: 17 additions & 7 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,19 @@
language: python
language:
python
python:
- "3.8" # current default Python on Travis CI
# command to install dependencies
#install:
# - pip install -r requirements.txt
# command to run tests
- "3.5"
install:
- pip install -U pip
- pip install -r requirements.txt
- pip install coverage
- pip install codecov
git:
depth: 50
jobs:
include:
- name: "project-1"
python: "3.8"
script:
- python3 -m pytest
- coverage run -m pytest -q code/
after_success:
- bash <(curl -s https://codecov.io/bash) -t 5c58df4e-d27a-405b-887b-498b8c62abc9
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,23 @@ It is a highly simplified version of git commit command. We are actively working
#### gits create_branch
This automatically checks out a new branch from local master , after pulling all the changes from the remote master to local master. The idea behind this is that this new branch should have all the latest commits before a developer starts working on them.

#### gits all-branch
This command lists all the branches on both local and remote repositories.


#### gits remote-branch
This command lists all the branches on remote repository.


#### gits init
This command initializes the local repository.

#### gits logging
This logs all the commands executed by the user, and also stores the output of each command

#### gits push
This pushes all the local changes of origin to the branch specified.

Note: More functionality are being added to this project. Please refer to the 'issues' tab for more information. In case you want to contribute to this project , please refer to 'Contributing.md' file.


Expand Down
41 changes: 41 additions & 0 deletions plan.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
## 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.