Skip to content

Contributing guide, inspiration, and docs cleanup #16

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
boldandbrad merged 3 commits into from
Apr 18, 2026
Merged

Contributing guide, inspiration, and docs cleanup #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f1ddf41
docs: add active dev and changelog message to readme
boldandbrad Apr 18, 2026
e2104fa
docs: add inspiration section to readme
boldandbrad Apr 18, 2026
48fe8a5
docs: add basic contributing guide, add reminder to release workflow
boldandbrad Apr 18, 2026
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
34 changes: 34 additions & 0 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Contributing

## Reporting Bugs

Open an [issue](https://github.com/boldandbrad/spin/issues) with details.

## Pull Requests

1. Fork the repo
2. Make your changes
3. Run `go build ./... && go vet ./...` to verify
4. Submit a PR

## Release Process

When releasing a new version:

1. **Update CHANGELOG.md** on `main`:
- Rename `## [Unreleased]` to `## [VERSION] - DATE` (e.g., `## [0.2.0] - 2026-04-18`)
- Add the release date
- Commit and push to `main`

2. **Create the release**:
- Go to [Actions → Release → Run workflow](https://github.com/boldandbrad/spin/actions/workflows/release.yml)
- Enter the version (e.g., `v0.2.0`)
- Click "Run workflow"

3. **Add release notes**:
- Copy the changelog section for the new version
- Paste into the GitHub release body

## Development

See [README.md](./README.md) for usage.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on:
workflow_dispatch:
inputs:
version:
description: 'Release version (e.g., v0.1.0)'
description: 'Release version (e.g., v0.1.0). Remember to update CHANGELOG.md on main before running!'
required: true
type: string

Expand Down
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
Interactively or programmatically scrobble tracks and albums to last.fm from the
terminal. That's it.

> **Note**: The `main` branch represents active development. For specific
> releases, see the README associated with that tag on
> [GitHub](https://github.com/boldandbrad/spin/tags). See
> [CHANGELOG](./CHANGELOG.md) for release notes.

## Install

```sh
Expand Down Expand Up @@ -176,6 +181,13 @@ spin history -n 50 # set the number of results
- 🔧 No config: just works out of the box
- 🔒 Secure: session keys stored in system keychain

## Inspiration

Spin was inspired by these projects:

- [scrobbler](https://github.com/hauzer/scrobbler) - A simple CLI Last.fm scrobbler
- [OpenWebScrobbler](https://github.com/elamperti/OpenWebScrobbler) - A web-based scrobbler

## License

[MIT](./LICENSE)
Loading