Skip to content

Update README with contribution guidelines #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sujaynsv merged 1 commit into from
Nov 7, 2025
Merged

Update README with contribution guidelines #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 34 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ A simple, self-hosted expense tracking web app built with Go. Track expenses, in
## Quick Start (Local)
1. Install Go and Docker.
2. Clone the repo: `git clone https://github.com/sujaynsv/ExpenseTrackerDevOps`
3. Run locally: `go run ./cmd/expenseowl` or use Docker: `docker run -p 8080:8080 tanq16/expenseowl:main`
3. Run locally: `go run ./cmd/expenseowl`
4. Open `http://localhost:8080` in your browser.

## Deployment
Expand All @@ -38,4 +38,36 @@ jobs:
steps:
- uses: actions/checkout@v4
- name: Trigger Render Deploy
run: curl -X POST ${{ secrets.RENDER_DEPLOY_HOOK }}
run: curl -X POST ${{ secrets.RENDER_DEPLOY_HOOK }}
```

## 🤝 Contributing Guidelines

We welcome contributions to **ExpenseOwl**! Whether it’s fixing bugs, adding features, or improving documentation, your help makes the project better.

### 🛠️ How to Contribute
1. **Fork the repository** on GitHub.
2. **Clone your fork** locally:
```bash
git clone https://github.com/your-username/ExpenseTrackerDevOps.git
```
3. **Create a new branch** for your changes:
```bash
git checkout -b feature/your-feature-name
```
4. **Make your changes** (ensure code is formatted with `go fmt`).
5. **Run tests** to confirm everything works:
```bash
go test ./...
```
6. **Commit and push** your changes:
```bash
git commit -m "Add: your feature description"
git push origin feature/your-feature-name
```
7. **Open a Pull Request** against the `main` branch.

---

### 📜 License
By contributing, you agree that your contributions will be licensed under the same license as the project (MIT, unless otherwise specified).
Loading