Skip to content

Commit d841ec0

Browse files
committed
feat: Add project governance files, update README with new sections and installation methods, and bump version to v1.2.2.
1 parent 4f23aff commit d841ec0

File tree

9 files changed

+228
-6
lines changed

9 files changed

+228
-6
lines changed
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug to help us improve
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Describe the Bug
10+
A clear and concise description of what the bug is.
11+
12+
## To Reproduce
13+
Steps to reproduce the behavior:
14+
1. Run `git-scope ...`
15+
2. Press `...`
16+
3. See error
17+
18+
## Expected Behavior
19+
What you expected to happen.
20+
21+
## Screenshots
22+
If applicable, add screenshots or terminal output.
23+
24+
## Environment
25+
- **OS**: [e.g., macOS 14.1, Ubuntu 22.04]
26+
- **git-scope version**: [e.g., 1.2.1]
27+
- **Go version** (if built from source): [e.g., 1.21]
28+
- **Terminal**: [e.g., iTerm2, Alacritty, Windows Terminal]
29+
30+
## Additional Context
31+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for git-scope
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Problem
10+
A clear description of the problem you're trying to solve.
11+
Example: "I'm frustrated when I have to..."
12+
13+
## Proposed Solution
14+
Describe the solution you'd like.
15+
16+
## Alternatives Considered
17+
Any alternative solutions or features you've considered.
18+
19+
## Additional Context
20+
Add any mockups, screenshots, or examples here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## Description
2+
3+
<!-- What does this PR do? Link to any related issues. -->
4+
5+
Fixes #
6+
7+
## Type of Change
8+
9+
- [ ] 🐛 Bug fix (non-breaking change that fixes an issue)
10+
- [ ] ✨ New feature (non-breaking change that adds functionality)
11+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to change)
12+
- [ ] 📚 Documentation update
13+
- [ ] 🔧 Refactoring (no functional changes)
14+
15+
## Checklist
16+
17+
- [ ] I have tested my changes locally
18+
- [ ] I have updated the documentation (if applicable)
19+
- [ ] My code follows the project's style guidelines
20+
- [ ] I have added tests that prove my fix/feature works (if applicable)
21+
22+
## Screenshots (if applicable)
23+
24+
<!-- Add screenshots or GIFs showing the change -->

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+

CODE_OF_CONDUCT.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
**Examples of behavior that contributes to a positive environment:**
10+
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy towards other community members
16+
17+
**Examples of unacceptable behavior:**
18+
19+
- Trolling, insulting/derogatory comments, and personal or political attacks
20+
- Public or private harassment
21+
- Publishing others' private information without explicit permission
22+
- Other conduct which could reasonably be considered inappropriate
23+
24+
## Enforcement
25+
26+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainer at [kumarbharath63@gmail.com]. All complaints will be reviewed and investigated promptly and fairly.
27+
28+
## Attribution
29+
30+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1.

CONTRIBUTING.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Contributing to git-scope
2+
3+
First off, thanks for taking the time to contribute! 🎉
4+
5+
## How Can I Contribute?
6+
7+
### Reporting Bugs
8+
9+
- **Check existing issues** first to avoid duplicates.
10+
- Use a **clear, descriptive title**.
11+
- Include steps to reproduce, expected vs actual behavior, and your OS/Go version.
12+
13+
### Suggesting Features
14+
15+
Open an issue with the `enhancement` label. Describe:
16+
- The problem you're trying to solve
17+
- Your proposed solution
18+
- Any alternatives you've considered
19+
20+
### Pull Requests
21+
22+
1. **Fork** the repo and create your branch from `main`.
23+
2. Run `go build ./...` and `go test ./...` to ensure everything works.
24+
3. Keep PRs focused—one feature or fix per PR.
25+
4. Update documentation if needed.
26+
5. Write a clear PR description.
27+
28+
## Development Setup
29+
30+
```bash
31+
# Clone your fork
32+
git clone https://github.com/YOUR_USERNAME/git-scope.git
33+
cd git-scope
34+
35+
# Build
36+
go build -o git-scope ./cmd/git-scope
37+
38+
# Run
39+
./git-scope
40+
```
41+
42+
## Code Style
43+
44+
- Follow standard Go conventions (`gofmt`, `go vet`).
45+
- Keep functions small and focused.
46+
- Add comments for non-obvious logic.
47+
48+
## Questions?
49+
50+
Open a [Discussion](https://github.com/Bharath-code/git-scope/discussions) or reach out on [Twitter/X](https://x.com/iam_pbk).
51+
52+
Thanks again! 🙏

README.md

Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
> **A fast TUI dashboard to view the git status of *all your repositories* in one place.** > Stop the `cd``git status` loop.
44
55
[![Go Report Card](https://goreportcard.com/badge/github.com/Bharath-code/git-scope)](https://goreportcard.com/report/github.com/Bharath-code/git-scope)
6+
[![GitHub Release](https://img.shields.io/github/v/release/Bharath-code/git-scope?color=8B5CF6)](https://github.com/Bharath-code/git-scope/releases)
67
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
78
[![GitHub stars](https://img.shields.io/github/stars/Bharath-code/git-scope)](https://github.com/Bharath-code/git-scope/stargazers)
89
[![Buy Me A Coffee](https://img.shields.io/badge/Buy%20Me%20A%20Coffee-FFDD00?style=flat&logo=buy-me-a-coffee&logoColor=black)](https://buymeacoffee.com/iam_pbk)
@@ -17,14 +18,19 @@ Get started in seconds.
1718

1819
### Homebrew (macOS/Linux)
1920
```bash
20-
brew tap Bharath-code/tap
21-
brew install git-scope
21+
brew tap Bharath-code/tap && brew install git-scope
2222
````
2323
### Update
2424
```bash
2525
brew upgrade git-scope
2626
````
27-
### From Source (windows)
27+
28+
### Universal Installer (macOS/Linux)
29+
```bash
30+
curl -sSL https://raw.githubusercontent.com/Bharath-code/git-scope/main/scripts/install.sh | sh
31+
```
32+
33+
### From Source (Windows)
2834

2935
```bash
3036
go install github.com/Bharath-code/git-scope/cmd/git-scope@latest
@@ -145,5 +151,34 @@ I built `git-scope` to solve the **"Multi-Repo Blindness"** problem. It gives me
145151

146152
MIT © [Bharath-code](https://github.com/Bharath-code)
147153

148-
```
149-
```
154+
---
155+
156+
## 🙏 Acknowledgements
157+
158+
Built with these amazing open-source projects:
159+
160+
- [Bubble Tea](https://github.com/charmbracelet/bubbletea) — The TUI framework
161+
- [Lip Gloss](https://github.com/charmbracelet/lipgloss) — Style definitions
162+
- [Bubbles](https://github.com/charmbracelet/bubbles) — TUI components (table, spinner, text input)
163+
164+
---
165+
166+
## ⭐ Star History
167+
168+
<a href="https://star-history.com/#Bharath-code/git-scope&Date">
169+
<picture>
170+
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Bharath-code/git-scope&type=Date&theme=dark" />
171+
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Bharath-code/git-scope&type=Date" />
172+
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Bharath-code/git-scope&type=Date" />
173+
</picture>
174+
</a>
175+
176+
---
177+
178+
## 👥 Contributors
179+
180+
<a href="https://github.com/Bharath-code/git-scope/graphs/contributors">
181+
<img src="https://contrib.rocks/image?repo=Bharath-code/git-scope" />
182+
</a>
183+
184+
Made with [contrib.rocks](https://contrib.rocks).

SECURITY.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
| Version | Supported |
6+
| ------- | ------------------ |
7+
| 1.2.x | :white_check_mark: |
8+
| < 1.2 | :x: |
9+
10+
## Reporting a Vulnerability
11+
12+
If you discover a security vulnerability, please report it responsibly:
13+
14+
1. **Do NOT** open a public issue.
15+
2. Email the maintainer directly at [kumarbharath63@gmail.com].
16+
3. Include a detailed description of the vulnerability and steps to reproduce.
17+
18+
You can expect:
19+
- Acknowledgment within 48 hours
20+
- Regular updates on the fix progress
21+
- Credit in the release notes (unless you prefer to remain anonymous)
22+
23+
Thank you for helping keep git-scope secure!

internal/tui/view.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ func (m Model) renderDashboard() string {
9494

9595
// Header with logo on its own line
9696
logo := lipgloss.NewStyle().Bold(true).Foreground(lipgloss.Color("#A78BFA")).Render("git-scope")
97-
version := lipgloss.NewStyle().Foreground(lipgloss.Color("#6B7280")).Render(" v1.2.1")
97+
version := lipgloss.NewStyle().Foreground(lipgloss.Color("#6B7280")).Render(" v1.2.2")
9898
b.WriteString(logo + version)
9999
b.WriteString("\n\n")
100100

0 commit comments

Comments
 (0)