testmycode / testmycode/tmc-server
As a tmc-developer I want API endpoints used by TMC-core to be documented and tested so that I don't need to stress about breaking stuff
Open
Nobody has claimed this yet.
user-story
- Dominant language
- Ruby
- Stars
- 51
- Forks
- 42
- Avg merge
- 1h 27m
- Merged PRs (30d)
- 1
Description
TODO: split up to sub user stories
- Proper tests
- Proper documentation
- test checkbox
Contributor guide
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 identifying the API endpoints used by TMC-core and the existing test and documentation entry points in tmc-server. Split the TODO into focused stories, then define endpoint coverage and documentation as the completion criteria.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- api, documentation, testing
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100