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
#404 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
ruby
Domain
api, documentation, testing

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.

Description

user-story

TODO: split up to sub user stories

  • Proper tests
  • Proper documentation
  • test checkbox
Dominant language
Ruby
Stars
51
Forks
42
Avg merge
1h 27m
Merged PRs (30d)
1

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 testmycode/tmc-server

All issues in testmycode/tmc-server

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.