Skip to content

Commit cdca18e

Browse files
committed
docs: add badges and contributing guidelines
1 parent c9d0c5e commit cdca18e

2 files changed

Lines changed: 50 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributing to Stacktower
2+
3+
Thanks for your interest in contributing!
4+
5+
## Getting Started
6+
7+
```bash
8+
git clone https://github.com/matzehuels/stacktower.git
9+
cd stacktower
10+
make install-tools # Install golangci-lint, goimports, govulncheck
11+
make check # Run all CI checks locally
12+
```
13+
14+
## Development Workflow
15+
16+
1. Fork the repository
17+
2. Create a feature branch (`git checkout -b feat/amazing-feature`)
18+
3. Make your changes
19+
4. Run checks: `make check`
20+
5. Commit with [Conventional Commits](https://www.conventionalcommits.org/) format:
21+
- `feat: add new feature`
22+
- `fix: resolve bug`
23+
- `docs: update readme`
24+
- `refactor: restructure code`
25+
- `test: add tests`
26+
- `ci: update workflows`
27+
6. Push and open a Pull Request
28+
29+
## Code Style
30+
31+
- Run `make fmt` before committing
32+
- Run `make lint` to check for issues
33+
- Keep changes focused and minimal
34+
35+
## Running Tests
36+
37+
```bash
38+
make test # Unit tests
39+
make e2e # End-to-end tests
40+
make cover # Tests with coverage
41+
```
42+
43+
## Questions?
44+
45+
Open an [issue](https://github.com/matzehuels/stacktower/issues) — we're happy to help!
46+

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Stacktower
22

3+
[![CI](https://github.com/matzehuels/stacktower/actions/workflows/ci.yml/badge.svg)](https://github.com/matzehuels/stacktower/actions/workflows/ci.yml)
4+
[![Go Report Card](https://goreportcard.com/badge/github.com/matzehuels/stacktower)](https://goreportcard.com/report/github.com/matzehuels/stacktower)
5+
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
6+
37
Inspired by [XKCD #2347](https://xkcd.com/2347/), Stacktower renders dependency graphs as **physical towers** where blocks rest on what they depend on. Your application sits at the top, supported by libraries below—all the way down to that one critical package maintained by *some dude in Nebraska*.
48

59
<p align="center">

0 commit comments

Comments
 (0)