mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-10 16:48:31 +02:00
a50566472f
- Add Japanese translations for documentation - Implement I18N framework - Update mkdocs.yml for multi-language support This commit significantly enhances the project's internationalization.
347 lines
22 KiB
HTML
347 lines
22 KiB
HTML
<!--
|
||
Copyright © 2012-2023 jrnl contributors
|
||
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||
-->
|
||
|
||
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="jrnl contributors" /><link rel="canonical" href="https://jrnl.sh/ja/contributing/" />
|
||
<link rel="shortcut icon" href="../../img/favicon.ico" />
|
||
<title>jrnlへの貢献 - jrnl</title>
|
||
<link rel="stylesheet" href="../../css/theme.css" />
|
||
<link rel="stylesheet" href="../../css/theme_extra.css" />
|
||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
||
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600" rel="stylesheet" />
|
||
<link href="../../assets/colors.css" rel="stylesheet" />
|
||
<link href="../../assets/theme.css" rel="stylesheet" />
|
||
<link href="../../assets/highlight.css" rel="stylesheet" />
|
||
|
||
<script>
|
||
// Current page data
|
||
var mkdocs_page_name = "jrnl\u3078\u306e\u8ca2\u732e";
|
||
var mkdocs_page_input_path = "ja/contributing.md";
|
||
var mkdocs_page_url = "/ja/contributing/";
|
||
</script>
|
||
|
||
<!--[if lt IE 9]>
|
||
<script src="../../js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||
<script>hljs.highlightAll();</script>
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav" role="document">
|
||
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search">
|
||
<a href="../.." class="icon icon-home"> jrnl
|
||
</a>
|
||
|
||
<div role="search">
|
||
<form id ="rtd-search-form" class="wy-form mkdocs-search" action="../../search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||
<button class="icon icon-search" aria-label="submit"></button>
|
||
</form>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../overview/">Overview</a>
|
||
</li>
|
||
</ul>
|
||
<p class="caption"><span class="caption-text">User Guide</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../installation/">Quickstart</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../usage/">Basic Usage</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../encryption/">Encryption</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../journal-types/">Journal Types</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../privacy-and-security/">Privacy and Security</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../formats/">Formats</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../advanced/">Advanced Usage</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../external-editors/">External Editors</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../tips-and-tricks/">Tips and Tricks</a>
|
||
</li>
|
||
</ul>
|
||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../reference-command-line/">Command Line</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../reference-config-file/">Configuration File</a>
|
||
</li>
|
||
</ul>
|
||
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">Contributing to jrnl</a>
|
||
</li>
|
||
</ul>
|
||
<p class="caption"><span class="caption-text">ja</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="../overview/">概要</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" >ユーザーガイド</a>
|
||
<ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../installation/">クイックスタート</a>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../usage/">基本的な使い方</a>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../encryption/">暗号化</a>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../journal-types/">ジャーナルの種類</a>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../privacy-and-security/">プライバシーとセキュリティ</a>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../formats/">フォーマット</a>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../advanced/">高度な使い方</a>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../external-editors/">外部エディタ</a>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../tips-and-tricks/">ヒントとコツ</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" >リファレンス</a>
|
||
<ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference-command-line/">コマンドライン</a>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference-config-file/">設定ファイル</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 current"><a class="reference internal current" >貢献</a>
|
||
<ul class="current">
|
||
<li class="toctree-l2 current"><a class="reference internal current" href="#">jrnlへの貢献</a>
|
||
<ul class="current">
|
||
<li class="toctree-l3"><a class="reference internal" href="#_1">目次</a>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#_2">行動規範</a>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#_3">バグの報告</a>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#_4">ドキュメントの編集</a>
|
||
<ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#_5">外部エディタとヒントとコツ</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#_6">テスト</a>
|
||
<ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#_7">プレリリース</a>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#_8">プルリクエスト</a>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#_9">バグ報告の確認</a>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#_10">自動テスト</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#_11">機能リクエストとアイデアの提出</a>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#_12">開発</a>
|
||
<ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#_13">環境のセットアップ</a>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#_14">ブランチの理解</a>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#_15">一般的な開発コマンド</a>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#_16">自動テストの更新</a>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#_17">プルリクエストの提出</a>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#_18">作業対象を見つける</a>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#python">新しいプログラマーとPythonを初めて使うプログラマーへの注意</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="../..">jrnl</a>
|
||
|
||
</nav>
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content"><!--
|
||
Copied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html
|
||
Then lightly modified for accessibility
|
||
-->
|
||
|
||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="../.." class="icon icon-home" aria-label="Docs"></a> »</li>
|
||
<li>ja »</li>
|
||
<li>貢献 »</li>
|
||
<li>jrnlへの貢献</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="https://github.com/jrnl-org/jrnl/edit/develop/docs/ja/contributing.md" class="icon icon-github"> Edit on GitHub</a>
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div class="section" itemprop="articleBody">
|
||
|
||
<!--
|
||
Copyright © 2012-2023 jrnl contributors
|
||
License: https://www.gnu.org/licenses/gpl-3.0.html
|
||
-->
|
||
|
||
<h1 id="jrnl">jrnlへの貢献</h1>
|
||
<p>jrnlへの貢献を歓迎します。バグの報告、ドキュメントの改善、リリースのテスト、機能やバグに関する議論への参加、コードの作成など、さまざまな形での貢献が可能です。</p>
|
||
<h2 id="_1">目次</h2>
|
||
<ul>
|
||
<li><a href="#行動規範">行動規範</a></li>
|
||
<li><a href="#バグの報告">バグの報告</a></li>
|
||
<li><a href="#ドキュメントの編集">ドキュメントの編集</a></li>
|
||
<li><a href="#テスト">テスト</a></li>
|
||
<li><a href="#機能リクエストとアイデアの提出">機能リクエストとアイデアの提出</a></li>
|
||
<li><a href="#開発">jrnlの開発</a></li>
|
||
</ul>
|
||
<h2 id="_2">行動規範</h2>
|
||
<p>まず始めに、<a href="https://github.com/jrnl-org/jrnl/blob/develop/CODE_OF_CONDUCT.md">行動規範</a>をお読みください。</p>
|
||
<h2 id="_3">バグの報告</h2>
|
||
<p>バグは<a href="https://github.com/jrnl-org/jrnl/issues/new/choose">新しい問題を開く</a>ことで報告してください。できるだけ詳細に説明してください。多くのバグは特定のオペレーティングシステムやPythonのバージョンに固有のものなので、その情報も含めてください！</p>
|
||
<h2 id="_4">ドキュメントの編集</h2>
|
||
<p>ドキュメントにタイプミスや間違いを見つけた場合は、すぐに修正してプルリクエストを送ってください。何を変更すべきか不確かだが問題を見つけた場合は、「ドキュメントの変更」タイプで<a href="https://github.com/jrnl-org/jrnl/issues/new/choose">新しい問題を開く</a>ことができます。</p>
|
||
<p>ドキュメントを編集するには、<strong>develop</strong>ブランチの<code>docs/*.md</code>ファイルを編集します。プロジェクトのルートディレクトリで<code>poe docs-run</code>を実行し、ブラウザで<a href="http://localhost:8000">localhost:8000</a>にアクセスすることで結果を確認できます。</p>
|
||
<h3 id="_5">外部エディタとヒントとコツ</h3>
|
||
<p>便利だと思うjrnlのコマンドラインテクニックを共有したい場合は、<a href="../tips-and-tricks/">"ヒントとコツ"セクション</a>に追加するとよいでしょう。特定の外部エディタとの統合に関するアドバイスは、<a href="../external-editors/">"外部エディタ"セクション</a>に追加できます。</p>
|
||
<h2 id="_6">テスト</h2>
|
||
<p>jrnlの保守作業の多くは、コーディングよりもテストに関わるものです。</p>
|
||
<p>jrnlの性質上、非常に機密性の高いデータを扱うため、データ損失のリスクを冒すことはできません。jrnlには包括的な自動テストスイートがありますが、ユーザーテストはこのリスクを軽減する上で極めて重要です。</p>
|
||
<h3 id="_7">プレリリース</h3>
|
||
<p><a href="https://pypi.org/project/jrnl/#history">プレリリースは通常のリリースと同様にPyPiを通じてデプロイされます</a>。<a href="https://pypi.org/project/pipx/">pipx</a>を使用してそれらを取得し、テストすることができます。各リリースで変更された内容については<a href="https://github.com/jrnl-org/jrnl/blob/develop/CHANGELOG.md">チェンジログ</a>を参照してください。</p>
|
||
<h3 id="_8">プルリクエスト</h3>
|
||
<p>gitに慣れている場合は、特定の<a href="https://github.com/jrnl-org/jrnl/pulls">プルリクエスト</a>をフェッチし、自分でテストして、結果を報告してください。新機能の動作をスクリーンキャストで示すとなおよいでしょう。</p>
|
||
<h3 id="_9">バグ報告の確認</h3>
|
||
<p><a href="https://github.com/jrnl-org/jrnl/issues?q=is%3Aissue+is%3Aopen+label%3Abug">GitHubの問題</a>には常にオープンなバグがあり、多くは特定のOS、Pythonバージョン、またはjrnlバージョンに固有のものです。「jrnl v2.2、MacOS 10.15、Python 3.8.1で確認」といった簡単なコメントでも、バグの追跡に非常に役立ちます。</p>
|
||
<h3 id="_10">自動テスト</h3>
|
||
<p>新しい自動テストの追加方法については、以下の開発セクションを参照してください。</p>
|
||
<h2 id="_11">機能リクエストとアイデアの提出</h2>
|
||
<p>jrnlに対する機能リクエストやアイデアがある場合は、<a href="https://github.com/jrnl-org/jrnl/issues/new/choose">新しい問題を開いて</a>機能の目的と関連するユースケースを説明してください。私たちはあなたと議論し、それがプロジェクトに適しているかどうかを決定します。</p>
|
||
<p>新機能について議論する際は、私たちの設計目標を念頭に置いてください。jrnlは<a href="https://en.wikipedia.org/wiki/Unix_philosophy">一つのことをうまく行う</a>ことを目指しています。私たちにとって、それは以下を意味します：</p>
|
||
<ul>
|
||
<li><em>機敏</em>であること</li>
|
||
<li>シンプルなインターフェースを持つこと</li>
|
||
<li>機能の重複を避けること</li>
|
||
</ul>
|
||
<h2 id="_12">開発</h2>
|
||
<h3 id="_13">環境のセットアップ</h3>
|
||
<p>jrnlを開発するには<a href="https://python-poetry.org/">poetry</a>をインストールする必要があります。poetryがプロジェクトの他のすべての依存関係を管理します。</p>
|
||
<h3 id="_14">ブランチの理解</h3>
|
||
<p>jrnlは主に2つのブランチを使用します：</p>
|
||
<ul>
|
||
<li><code>develop</code> - 継続的な開発用</li>
|
||
<li><code>release</code> - リリース用</li>
|
||
</ul>
|
||
<p>一般的に、プルリクエストは<code>develop</code>ブランチに対して行われるべきです。</p>
|
||
<h3 id="_15">一般的な開発コマンド</h3>
|
||
<p><code>pyproject.toml</code>にコマンドの一覧があります。ユーザーは<code>poe</code>の後にコマンド名を入力することでコマンドを実行できます（<a href="https://github.com/nat-n/poethepoet">Poe the Poet</a>は単独で、または<code>poetry install</code>の一部としてインストールできます）。</p>
|
||
<p>典型的な開発ワークフローには以下が含まれます：</p>
|
||
<ul>
|
||
<li>依存関係のインストール：</li>
|
||
<li><code>poetry install</code></li>
|
||
<li>仮想環境の有効化：</li>
|
||
<li><code>poetry shell</code></li>
|
||
<li>仮想環境でソースを実行：</li>
|
||
<li><code>jrnl</code>（必要に応じて引数を付けて）</li>
|
||
<li>テストの実行：</li>
|
||
<li><code>poe test</code></li>
|
||
<li>コードのフォーマットをスタイルに標準化：</li>
|
||
<li><code>poe format</code></li>
|
||
</ul>
|
||
<h3 id="_16">自動テストの更新</h3>
|
||
<p>バグの解決や新機能の追加時には、将来その機能が壊れるのを防ぐためにテストを追加してください。テストでカバーされていない機能に気づいた場合は、テストのみのプルリクエストを提出することもできます。</p>
|
||
<p>テストには、ユニットテスト用に<a href="https://docs.pytest.org">pytest</a>を、統合テスト用に<a href="https://pytest-bdd.readthedocs.io/">pytest-bdd</a>を使用しています。すべてのテストは<code>tests</code>フォルダーにあります。</p>
|
||
<p>多くのテストは、他のテストと同じフォーマットの<code>*.feature</code>ファイルを編集するだけで作成できます。より複雑な機能については、<code>tests/lib/</code>にステップを実装し、それを<code>feature</code>ファイルのテストで実行する必要があるかもしれません。</p>
|
||
<h3 id="_17">プルリクエストの提出</h3>
|
||
<p>準備ができたら、プルリクエスト（PR）を提出してください。jrnlのメンテナーは通常2週間ごとにプルリクエストをレビューしますが、継続的統合パイプラインは数分以内にあなたのコードに対して自動テストを実行し、さまざまな環境で見つかった問題を報告します。</p>
|
||
<p>プルリクエストのテンプレートにはハウスキーピング項目のチェックリストが含まれています。提出時に必要に応じてそれらを記入してください。</p>
|
||
<p>プルリクエストにテスト失敗が含まれている場合、おそらくレビューされず、確実に承認されません。ただし、テスト失敗の解決に助けが必要な場合は、PRでその旨を言及してください。</p>
|
||
<h3 id="_18">作業対象を見つける</h3>
|
||
<p><a href="https://github.com/jrnl-org/jrnl/issues">jrnlのGitHub Issues</a>を<a href="https://github.com/jrnl-org/jrnl/labels">ラベル</a>で検索して、作業対象を見つけることができます。以下は検索する価値のあるラベルです：</p>
|
||
<ul>
|
||
<li><a href="https://github.com/jrnl-org/jrnl/labels/critical">critical</a></li>
|
||
<li><a href="https://github.com/jrnl-org/jrnl/labels/help%20wanted">help wanted</a></li>
|
||
<li><a href="https://github.com/jrnl-org/jrnl/labels/bug">bug</a></li>
|
||
<li><a href="https://github.com/jrnl-org/jrnl/labels/enhancement">enhancement</a></li>
|
||
</ul>
|
||
<p><a href="https://github.com/jrnl-org/jrnl/milestones">マイルストーン</a>をレビューして、プロジェクトの優先事項を把握することもできます。</p>
|
||
<h3 id="python">新しいプログラマーとPythonを初めて使うプログラマーへの注意</h3>
|
||
<p>jrnlは発足以来かなり成長しましたが、全体的な複雑さ（エンドユーザープログラムとしては）は比較的低く、コードを理解しやすいと思います。</p>
|
||
<p>質問がある場合は、遠慮なく聞いてください！Pythonは初心者プログラマーを歓迎し、オープンなコミュニティとして知られています。コードをフォークして自由に試してみてください！私たちと共有したいものを作成した場合は、プルリクエストを作成してください。プルリクエストが完璧で、慣用的で、すぐにマージできるコードであることは期待していません。一緒に取り組んでいきましょう！</p>
|
||
|
||
</div>
|
||
</div><footer>
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||
<a href="../reference-config-file/" class="btn btn-neutral float-left" title="設定ファイル"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<!-- Copyright etc -->
|
||
</div>
|
||
|
||
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
</footer>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
<div class="rst-versions" role="note" aria-label="Versions">
|
||
<span class="rst-current-version" data-toggle="rst-current-version">
|
||
|
||
<span>
|
||
<a href="https://github.com/jrnl-org/jrnl/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||
</span>
|
||
|
||
|
||
<span><a href="../reference-config-file/" style="color: #fcfcfc">« Previous</a></span>
|
||
|
||
|
||
</span>
|
||
</div>
|
||
<script src="../../js/jquery-3.6.0.min.js"></script>
|
||
<script>var base_url = "../..";</script>
|
||
<script src="../../js/theme_extra.js"></script>
|
||
<script src="../../js/theme.js"></script>
|
||
<script src="../../search/main.js"></script>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html>
|