kurusugawa-computer / kurusugawa-computer/annofab-cli
ReadTheDocsのドキュメントにもインストール方法などを記載する
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8
- Forks
- 0
- Avg merge
- 51m
- Merged PRs (30d)
- 12
Description
インストール方法はREADME.mdには記載されているが、https://annofab-cli.readthedocs.io/ja/latest/index.html には記載されていない。
README.mdを見ずに https://annofab-cli.readthedocs.io/ja/latest/index.html を最初から見るユーザーもいるので、https://annofab-cli.readthedocs.io/ja/latest/index.html にもインストール方法などを記載する。
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 comparing the installation instructions in README.md with the Japanese ReadTheDocs index at https://annofab-cli.readthedocs.io/ja/latest/index.html. Done means the ReadTheDocs documentation also includes the installation method and other relevant introductory information, so users do not need to consult README.md.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100