Create examples

Open
#6 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
github, openapi, python
Domain
api, documentation

Research direction

Start by reviewing the ghapi repository and its existing Python and CLI interfaces, then group the requested examples into a smaller, agreed scope. Use the listed GitHub API tasks and the linked awesome-actions collection as references. Done should mean the selected Python and CLI or GitHub Actions how-tos are documented and runnable.

Written by the indexing model from the issue text.

Description

Here's some examples we could create for ghapi without gh actions - show both Python and CLI (where appropriate) how-tos:

  • Basic tutorial on finding operations, key concepts, etc
  • Equivalent of some gh commands
    • Create an issue
    • Create a gist
    • View a gist
    • Download a release asset
    • Fork and clone a repo
  • Ping a webhook
  • Run a workflow
  • View an issue and reply/close with template response
    • Search for an issue
    • Discuss pagination
    • Show issues/PRs you are assigned to; show those that aren't assigned
  • Add text to a file in a repo
  • Show all added or updated issues and PRs in last hours, except updates from user
    • For a repo; for a user; for an org
    • Show those without a reply for days
  • Plot # forks and clones by day for last month
  • Render markdown
  • fastrelease

Here's some examples we could create for ghapi with gh actions (just show Python how-tos):

  • Check PRs are in an acceptable format, and it not, add a PR reply explaining how to fix, and create a CI fail
  • Multi-OS go build and release (copy over from hugo-mathjax)
  • Use pip cache
  • Lock stale issues/PRs
  • More examples
Dominant language
Python
Stars
687
Forks
69
Avg merge
1m
Merged PRs (30d)
2

Contributor guide

Open the contributing guide

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.

More from AnswerDotAI/ghapi

All issues in AnswerDotAI/ghapi

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.