Skip to content

Commit ddcba76

Browse files
committed
✨ feat(doc): Update CONTRIBUTING.md and INSTALL.sh with new information.
1 parent da80c2c commit ddcba76

File tree

11 files changed

+219
-93
lines changed

11 files changed

+219
-93
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,21 @@ Thank you for your interest in contributing to Git Quick!
55
## Development Setup
66

77
1. Clone the repository:
8+
89
```bash
9-
git clone https://github.com/yourusername/git-quick.git
10+
git clone https://github.com/vswaroop04/git-quick.git
1011
cd git-quick
1112
```
1213

1314
2. Create a virtual environment:
15+
1416
```bash
1517
python -m venv venv
1618
source venv/bin/activate # On Windows: venv\Scripts\activate
1719
```
1820

1921
3. Install in development mode:
22+
2023
```bash
2124
pip install -e ".[dev]"
2225
```
@@ -47,11 +50,13 @@ git-quick/
4750
## Code Style
4851

4952
We use:
53+
5054
- **Black** for code formatting
5155
- **Ruff** for linting
5256
- **MyPy** for type checking
5357

5458
Run formatters:
59+
5560
```bash
5661
black git_quick tests
5762
ruff check git_quick tests
@@ -72,6 +77,7 @@ We follow [Conventional Commits](https://www.conventionalcommits.org/):
7277
```
7378

7479
Types:
80+
7581
- `feat`: New feature
7682
- `fix`: Bug fix
7783
- `docs`: Documentation
@@ -82,6 +88,7 @@ Types:
8288
- `chore`: Maintenance
8389

8490
Examples:
91+
8592
```
8693
feat(ai): add support for Claude AI
8794
fix(cli): handle empty git repositories
@@ -95,6 +102,7 @@ docs: update installation instructions
95102
- Aim for >80% code coverage
96103

97104
Run tests:
105+
98106
```bash
99107
pytest --cov=git_quick tests/
100108
```
@@ -122,16 +130,19 @@ pytest --cov=git_quick tests/
122130
## VS Code Extension Development
123131

124132
1. Navigate to extension directory:
133+
125134
```bash
126135
cd vscode-extension
127136
```
128137

129138
2. Install dependencies:
139+
130140
```bash
131141
npm install
132142
```
133143

134144
3. Open in VS Code:
145+
135146
```bash
136147
code .
137148
```
@@ -156,6 +167,7 @@ To add a new command:
156167
5. Update documentation
157168

158169
Example:
170+
159171
```python
160172
# git_quick/commands/your_command.py
161173
def your_command(git: GitUtils):
@@ -175,6 +187,7 @@ def your_command():
175187
To add a new AI provider:
176188

177189
1. Add provider method in `git_quick/ai_commit.py`:
190+
178191
```python
179192
def _generate_yourprovider(self, diff: str, files: list[str]) -> str:
180193
# Implementation

INSTALL.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,5 +154,5 @@ echo " vim ~/.gitquick/config.toml"
154154
echo ""
155155
echo "Get Help:"
156156
echo " git-quick --help"
157-
echo " https://github.com/yourusername/git-quick"
157+
echo " https://github.com/vswaroop04/git-quick"
158158
echo ""

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,22 +26,26 @@ pip install git-quick
2626
### Core Commands
2727

2828
- **`git-quick`** - Combines `git add`, `commit`, and `push` with smart defaults
29+
2930
- Auto-detects branch
3031
- AI-generated commit messages from diffs
3132
- Emoji/scope support (gitmoji-style)
3233
- Interactive mode for fine-tuning
3334

3435
- **`git-quick story`** - Compact, colorized commit summary
36+
3537
- Shows commits since last release/tag
3638
- Grouped by author, date, or type
3739
- Export to markdown for changelogs
3840

3941
- **`git-quick time start`** - Track development time per branch/feature
42+
4043
- Automatic time tracking per branch
4144
- Reports with breakdowns
4245
- Integration with time-tracking tools
4346

4447
- **`git-quick sync`** - Update all local branches safely
48+
4549
- Stash uncommitted changes
4650
- Fast-forward all branches
4751
- Conflict detection and reporting
@@ -86,8 +90,9 @@ ollama pull llama3
8690
```
8791

8892
### From Source
93+
8994
```bash
90-
git clone https://github.com/yourusername/git-quick.git
95+
git clone https://github.com/vswaroop04/git-quick.git
9196
cd git-quick
9297
pip install -e .
9398
```
@@ -125,13 +130,16 @@ git-sync-all # Sync all branches
125130
On your first run, git-quick will ask you to choose an AI provider:
126131

127132
1. **Ollama** (Recommended) - Free, local, private AI
133+
128134
- Automatically installs and downloads model
129135
- No API keys needed
130136

131137
2. **OpenAI** - Best quality, requires API key
138+
132139
- Enter your API key when prompted
133140

134141
3. **Anthropic (Claude)** - Great for technical commits
142+
135143
- Enter your API key when prompted
136144

137145
4. **No AI** - Smart fallback mode

0 commit comments

Comments
 (0)