Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Write documentation on best practices for researcher DB access

オープン
#14 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
45/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
領域
documentation

調査の方向性

.github/workflows/build_docs.yml にあるドキュメントのビルドワークフローと、docs.ooni.org/meta/ にあるガイダンス(ドキュメントのビルド方法を含む)を確認してください。研究者によるデータベースアクセスのベストプラクティスを扱うドキュメントまたはセクションを docs.ooni.org に追加し、その結果がドキュメントのビルドに含まれるようにしてください。

索引モデルが issue の本文から書いたものです。

説明

docs good first issue

During the review of the OONI Data & Systems Usage Policy document it came up that:

Maybe at some point it would be a good idea to add a "good practices" section with this kind of thing
@LDiazN

It would be great to write this up as part of a document inside of docs.ooni.org: https://github.com/ooni/data/blob/main/.github/workflows/build_docs.yml
also: https://docs.ooni.org/meta/
and https://docs.ooni.org/meta/#how-documentation-is-built

主要言語
TypeScript
スター
3
フォーク
2
平均マージ
6日 7時間
マージ済み PR(30日)
3

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ooni/docs のほかの issue

ooni/docs の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。