Northeastern-Electric-Racing / Northeastern-Electric-Racing/Calypso
Add GIT API
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 2
- Forks
- 2
- Avg merge
- 6d 20h
- Merged PRs (30d)
- 3
Description
Description
Add a GIT API to safely interact with the Odyssey-Configurations repository.
Acceptance Criteria
It works with Odyssey-Configurations. Bonus: Automatically clone the repository to the clap/CLI provided path if it doesn't exist.
Proposed Solution
Use a git client library. Add functions for:
- Branch creation and switching
- Fetching diffs
- committing data to pre-configured and included files (metadata.json and configuration.json)
- a thread/daemon to push/pull automatically when internet is available
Recommended a seperate git rs file then a thread in main which processes all requests to do things via a git object. alternatively mutex the git client.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the clap/CLI path handling and the main request-processing flow described in the issue. Review how a separate git module could interact with Odyssey-Configurations, including metadata.json and configuration.json, and clarify the thread or mutex approach. Done means the supported branch, diff, commit, clone, and synchronization behavior works with that repository.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, rust
- Domain
- backend, cli
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100