Merge pull request #148 from bnema/docs/contributing-guidelines

docs: add contributing guidelines and go report card badge

commit: ad477c044948e1aee7db74edb48aa8eb516ab3c9
author: bnema · 9mo ago · 2026-01-25 03:36 UTC
committer: GitHub · 9mo ago · 2026-01-25 03:36 UTC
merge of: 4015f5d + 26c6f46 · diff against the first parent
signature: GPG UnverifiedB5690EEEBB952194 The key is unknown

2 files · +58 -1

A CONTRIBUTING.md +49 -0

@@ -0,0 +1,49 @@
	1	+	# Contributing to Dumber
	2	+
	3	+	Thanks for your interest in contributing to Dumber!
	4	+
	5	+	## What We Accept
	6	+
	7	+	\| Type \| Accepted \|
	8	+	\|------\|----------\|
	9	+	\| Bug fixes \| Yes \|
	10	+	\| Performance optimizations \| Yes \|
	11	+	\| Stability improvements \| Yes \|
	12	+	\| WebUI/UX improvements \| Yes \|
	13	+	\| New features \| No \|
	14	+
	15	+	We're not accepting new feature contributions. Dumber follows a specific vision and feature set that we maintain internally. If you have a feature idea, feel free to open an issue for discussion, but PRs adding new features will be closed.
	16	+
	17	+	## Pull Request Process
	18	+
	19	+	Target the `next` branch, not `main`.
	20	+
	21	+	All PRs must be opened against the `next` branch. We test changes in `next` to ensure stability before merging to `main` for release.
	22	+
	23	+	```bash
	24	+	git checkout -b my-fix
	25	+	# make your changes
	26	+	git push origin my-fix
	27	+	# open PR against `next` branch
	28	+	```
	29	+
	30	+	## Before Submitting
	31	+
	32	+	Go code:
	33	+	1. Run `make lint` and fix any issues
	34	+	2. Run `make test` and ensure tests pass
	35	+	3. Run `go fmt` on any Go code changes
	36	+
	37	+	WebUI code (in `webui/`):
	38	+	1. Run `npm run lint` to fix linting issues
	39	+	2. Run `npm run fmt` to format with Prettier
	40	+	3. Run `npm run check` to run svelte-check
	41	+
	42	+	Keep commits focused and use single-line commit messages.
	43	+
	44	+	## Reporting Bugs
	45	+
	46	+	Open an issue at [github.com/bnema/dumber/issues](https://github.com/bnema/dumber/issues) with:
	47	+	- Steps to reproduce
	48	+	- Expected vs actual behavior
	49	+	- System info (distro, Wayland compositor, WebKitGTK version)

@@ -0,0 +1,49 @@
	1	+	# Contributing to Dumber
	2	+
	3	+	Thanks for your interest in contributing to Dumber!
	4	+
	5	+	## What We Accept
	6	+
	7	+	\| Type \| Accepted \|
	8	+	\|------\|----------\|
	9	+	\| Bug fixes \| Yes \|
	10	+	\| Performance optimizations \| Yes \|
	11	+	\| Stability improvements \| Yes \|
	12	+	\| WebUI/UX improvements \| Yes \|
	13	+	\| New features \| No \|
	14	+
	15	+	We're not accepting new feature contributions. Dumber follows a specific vision and feature set that we maintain internally. If you have a feature idea, feel free to open an issue for discussion, but PRs adding new features will be closed.
	16	+
	17	+	## Pull Request Process
	18	+
	19	+	Target the `next` branch, not `main`.
	20	+
	21	+	All PRs must be opened against the `next` branch. We test changes in `next` to ensure stability before merging to `main` for release.
	22	+
	23	+	```bash
	24	+	git checkout -b my-fix
	25	+	# make your changes
	26	+	git push origin my-fix
	27	+	# open PR against `next` branch
	28	+	```
	29	+
	30	+	## Before Submitting
	31	+
	32	+	Go code:
	33	+	1. Run `make lint` and fix any issues
	34	+	2. Run `make test` and ensure tests pass
	35	+	3. Run `go fmt` on any Go code changes
	36	+
	37	+	WebUI code (in `webui/`):
	38	+	1. Run `npm run lint` to fix linting issues
	39	+	2. Run `npm run fmt` to format with Prettier
	40	+	3. Run `npm run check` to run svelte-check
	41	+
	42	+	Keep commits focused and use single-line commit messages.
	43	+
	44	+	## Reporting Bugs
	45	+
	46	+	Open an issue at [github.com/bnema/dumber/issues](https://github.com/bnema/dumber/issues) with:
	47	+	- Steps to reproduce
	48	+	- Expected vs actual behavior
	49	+	- System info (distro, Wayland compositor, WebKitGTK version)

M README.md +9 -1

@@ -1,6 +1,6 @@
1	1		# Dumber
2	2
3		-	[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
	3	+	[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![Go Report Card](https://goreportcard.com/badge/github.com/bnema/dumber)](https://goreportcard.com/report/github.com/bnema/dumber)
4	4
5	5		A TTY-inspired browser multiplexer for tiling window managers.
6	6

@@ -117,6 +117,14 @@ make build
117	117		\| `make lint` \| Run golangci-lint \|
118	118		\| `make flatpak-build` \| Build Flatpak bundle \|
119	119
	120	+	## Contributing
	121	+
	122	+	We welcome bug fixes, performance/stability improvements, and WebUI/UX enhancements. We're not accepting new feature PRs.
	123	+
	124	+	All PRs must target the `next` branch. We test there first before releasing to `main`.
	125	+
	126	+	See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
	127	+
120	128		## Community
121	129
122	130		- [Report bugs](https://github.com/bnema/dumber/issues)

 # Dumber
-[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![Go Report Card](https://goreportcard.com/badge/github.com/bnema/dumber)](https://goreportcard.com/report/github.com/bnema/dumber)
 A TTY-inspired browser multiplexer for tiling window managers.
 | `make lint` | Run golangci-lint |
 | `make flatpak-build` | Build Flatpak bundle |
+## Contributing
+We welcome bug fixes, performance/stability improvements, and WebUI/UX enhancements. We're not accepting new feature PRs.
+**All PRs must target the `next` branch.** We test there first before releasing to `main`.
+See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
 ## Community
 - [Report bugs](https://github.com/bnema/dumber/issues)