Ptt-official-app/pttbbs-backend

More complete swagger document in README.md

Open

#122 opened on Feb 1, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (17 forks)github user discovery
good first issue

Repository metrics

Stars
 (34 stars)
PR merge metrics
 (Avg merge 21d 14h) (3 merged PRs in 30d)

Description

put the following steps in https://github.com/Ptt-official-app/go-openbbsmiddleware#swagger

  1. pip install virtualenv
  2. virtualenv --python=python3 --prompt='[apidoc] ' __
  3. source __/bin/activate
  4. cd apidoc; pip install .; pip uninstall apidoc -y; python setup.py develop; cd ..

Contributor guide

Research direction
Follow the steps provided in the issue and update the README.md with the Swagger documentation setup instructions.
Tech stack
gopython
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80