axodotdev / axodotdev/axoupdater

Document GitHub API rate limit considerations

Open
#73 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
31
Forks
13
PR merge metrics
No merged PRs in 30d

Description

We're using unauthenticated API requests to GitHub which is subject to a tighter rate limit than an authenticated rate limit. In normal usage, this isn't a problem, but it's possible to spam update requests and get rate limited. We should make sure to document this.

Contributor guide

Open the contributing guide

Research direction

The issue names no documentation file, test, or entry point. Locate the project's existing documentation and GitHub API guidance first; done means documenting the tighter unauthenticated rate limit and the risk of repeated update requests causing rate limiting.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.