palantir / palantir/go-githubapp

Include docs on creating github app for example

Open
#18 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
450
Forks
70
Avg merge
14h 23m
Merged PRs (30d)
26

Description

Would it be possible to add code above the “example” section of the docs, or in a readme in that directory, that walks through the right github app settings for running the example?

As a first-time user of this library, I went to try the example. Running the example server was super straightforward, but I was left to guess at what options to set when creating my github app. Specifically, I had to infer what permissions to ask for, given the description of what the app would do, and I had to search in the code to find what “DefaultWebhookRoute” referred to.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the documentation around the “example” section and the example directory's README, then inspect the example and the DefaultWebhookRoute reference mentioned in the issue. Document the GitHub App settings, required permissions, and webhook route so a first-time user can run the example without searching the code.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, go
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.