microsoftgraph / microsoftgraph/msgraph-sdk-python
Auto-generated documentation errors
オープン
まだ誰も着手していません。
documentation
- 主要言語
- Python
- スター
- 630
- フォーク
- 96
- 平均マージ
- 15時間 20分
- マージ済み PR(30日)
- 3
説明
Hi.
Adding some graph functionality to an application, I sometimes come across minor errors in the https://learn.microsoft.com/en-us/graph/api code snippets. When I go to create a PR for the typo, there is a message at the head of the snippet that says:
description: "Automatically generated file. DO NOT MODIFY"
And I'm stuck.
Am I able to submit PRs for typos, or is opening an issue here the way to handle it?
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
レポート内の Microsoft Graph API ドキュメントへのリンクを出発点として使用してください。タイプミスの修正をこのリポジトリで行うべきか、自動生成されるスニペットのソースで行うべきかを判断してください。正しいコントリビューションの経路が確立され、文書化された時点で Issue は解決となります。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- api, documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 20/100