Contributing

Thank you for investing your time in contributing to our project!

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Getting Started

To navigate our codebase with confidence, familiar yourself with:

• Bubbletea - the TUI framework we’re using
• The Elm architecture
• charmbracelet/glow - for parsing and presenting markdown

Code structure

• ui/ - this is the code that’s responsible on rendering the different parts of the TUI
• data/ - the code that fetches data from GitHub’s GraphQL API
• config/ - code to parse the user’s config.yml file
• utils/ - various utilities

Issues

Create a new issue

If you spot a problem, first search if an issue already exists.

If a related issue doesn’t exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through our existing issues to find one that interests you.

Make Changes

1. Fork the repository.

   git clone https://github.com/dlvhdr/gh-dash.git

   Or, if you have the gh cli:

   gh repo clone dlvhdr/gh-dash

2. Install Go: https://go.dev/

3. Create a working branch and start with your changes!

Pull Request

When you’re finished with the changes, create a pull request.

• Fill the “Ready for review” template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
• Don’t forget to link PR to issue if you are solving one.

Debugging

• Pass the debug flag: go run gh-dash.go --debug
• Write to the log using Go’s builtin log package
• View the log by running tail -f debug.log

import "github.com/charmbracelet/log"

// more code...

log.Debug("Some message", "someVariable", someVariable)

Your PR is merged!

Congratulations 🎉🎉