cpprefjp.github.io/start_editing.html at master · cpprefjp/cpprefjp.github.io · GitHub

History

765 lines (716 loc) · 41.2 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

<!doctype html>

<head>

window.dataLayer = window.dataLayer || [];

function gtag(){dataLayer.push(arguments);}

gtag('js', new Date());

gtag('config', 'G-NXNBNVBTJS');

</script>

<title>はじめてのコントリビュート - cpprefjp C++日本語リファレンス</title>

C++,標準ライブラリ,リファレンス,ドキュメント,STL,std,

document.addEventListener('DOMContentLoaded', function() {

var kn = new Kunai;

kn.cpprefjp();

});

</script>

</head>

<body>

<span class="sr-only">Toggle navigation</span>

</button>

<div class="title">cpprefjp - C++日本語リファレンス</div>

</div>

</a>

</div>

<li>

(function() {

var cx = '013316413321391058734:ji_u66hl7hq';

var gcse = document.createElement('script');

gcse.type = 'text/javascript';

gcse.async = true;

gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') +

'//www.google.com/cse/cse.js?cx=' + cx;

var s = document.getElementsByTagName('script')[0];

s.parentNode.insertBefore(gcse, s);

})();

</script>

</div>

</li>

<li>

<a href="https://github.com/cpprefjp/site">GitHub Project</a>

</li>

</ul>

</div>

</nav>

</header>

<gcse:searchresults></gcse:searchresults>

</div>

<span>

</a>

</span>

</li>

<span>

<span itemprop="name">はじめてのコントリビュート</span>

</span>

</li>

</ol>

</div>

最終更新日時:

<time itemprop="datePublished" class="js-local-time"

datetime="2025-12-01T10:13:02+09:00">

2025年12月01日 10時13分02秒 (JST)

</time>

<br/>

<span itemprop="name">Akira Takahashi</span>

</span>

が更新

</small></p>

(function () {

// 最終更新日時を閲覧者のローカルタイムゾーンで表示し直す (issue #53 の正規化)。

// JS が無効な環境ではサーバ生成の JST 表記がそのまま残る。

function pad(n) { return (n < 10 ? '0' : '') + n; }

var els = document.querySelectorAll('time.js-local-time[datetime]');

for (var i = 0; i < els.length; i++) {

var el = els[i];

var d = new Date(el.getAttribute('datetime'));

if (isNaN(d.getTime())) { continue; }

var tz = '';

try {

var parts = new Intl.DateTimeFormat(undefined, { timeZoneName: 'short' }).formatToParts(d);

for (var j = 0; j < parts.length; j++) {

if (parts[j].type === 'timeZoneName') { tz = parts[j].value; break; }

}

} catch (e) {}

el.textContent = d.getFullYear() + '年' + pad(d.getMonth() + 1) + '月' + pad(d.getDate()) + '日 '

+ pad(d.getHours()) + '時' + pad(d.getMinutes()) + '分' + pad(d.getSeconds()) + '秒'

+ (tz ? ' (' + tz + ')' : '');

}

})();

</script>

<span class="fa fa-fw fa-clock-o fa-flip-horizontal"></span>履歴

</a>

<span class="fa fa-fw fa-pencil"></span>編集

</a>

</p>

</div>

<h1 itemprop="name"><span class="token">はじめてのコントリビュート</span></h1>

<div itemprop="articleBody"><p>本cpprefjpサイトは、GitHub Pagesのサービス上に構築されていますが、編集自体はGitHubリポジトリにあるMarkdown形式のプレーンテキストで行います。</p>

<p>cpprefjpサイトのGitHubリポジトリは、以下になります：</p>

<ul>

<li><a href="https://github.com/cpprefjp/site" target="_blank">https://github.com/cpprefjp/site</a></li>

</ul>

<p>また、cpprefjpサイト上に掲載する画像ファイルのようなリソースも、GitHubリポジトリで管理しています。</p>

<ul>

<li><a href="https://github.com/cpprefjp/image" target="_blank">画像ファイルリポジトリ</a></li>

</ul>

<h2>GitHubからcpprefjpサイトへの自動反映</h2>

<p>GitHub上で記述したMarkdown(.md)形式のリファレンスは、GitHub Actionsによって自動的にHTMLに変換されて、cpprefjpサイトに反映されます。</p>

<p>cpprefjp/site へ push すると、すぐに反映されます。</p>

<p>毎日深夜0時ころに全ページの変換を行います。ページを追加したときのサイドバーの更新や、<code>GLOBAL_QUALIFY_LIST.txt</code>を編集した場合の適用は、そのときの変換で全ページに変更が適用されます。</p>

<p>日次の変換中にコミットした変更は、日次の変換がおわったあと (だいたい1時間30分〜2時間くらい) に自動で変換・反映されます。</p>

<h3>自動デプロイ、自動テスト</h3>

<p>本リポジトリでは、GitHub Actionsを使用して、自動デプロイと自動テストを行っています。</p>

<p>Pull Request 時にも自動テストと自動プレビュー生成を行います。</p>

<h4>自動デプロイ</h4>

<p>buildアクションで、MarkdownからHTMLへの変換と、GitHub Pagesへのデプロイを行っています。</p>

<p>変換時になんらかのエラーが発生した場合には、GitHub Actionsが失敗します。その場合、手元で修正して再度git pushを行うことになります</p>

<p>変換エラーではなく、GitHub Pagesリポジトリへのgit pushに失敗した場合 (buildアクションの実行中に新たなコミットがgit pushされた場合など) には、そのbuildアクションに対してRe-run jobを実行し、再度変換を行ってください。</p>

<h4>自動テスト</h4>

<ul>

<li>checkアクション<ul>

<li>禁止文字の検出 (detect forbidden characters)<ul>

<li>ソフトハイフンやゼロ幅スペースなどの禁止された文字が使用されている場合に、エラーが発生する</li>

</ul>

</li>

<li>内部リンクの誤り検出 (inner link check)<ul>

<li>サイト内のリンクが存在しない、または存在しているのに.nolinkを指定している場合にエラーが発生する</li>

<li><a href="https://github.com/cpprefjp/site/actions/workflows/check.yml" target="_blank">GitHub Actionsの実行ログ</a>で、どのページのどのリンクが不正かがわかるので、それを修正すること</li>

</ul>

</li>

<li>コード修飾の誤り検出 (code qualify check)<ul>

<li>コードブロック中のコードを修飾しているのに、その修飾対象がない場合に、エラーが発生する</li>

<li><a href="https://github.com/cpprefjp/site/actions/workflows/check.yml" target="_blank">GitHub Actionsの実行ログ</a>で、どのページのどのコード修飾が不正かがわかるので、それを修正すること</li>

</ul>

</li>

<li>グローバル修飾リストの誤り検出 (global qualify check)<ul>

<li><code>GLOBAL_QUALIFY_LIST.txt</code>に登録されている識別子のうち、<code>PRIMARY_OVERLOAD_SPECIALIZATION_LIST.txt</code>に登録されているプライマリ宣言へのリンク以外が登録されている場合に、エラーが発生する</li>

</ul>

</li>

<li>所属ヘッダメタ情報の誤り検出 (meta header check)<ul>

<li><code>[meta header]</code>または<code>[meta module]</code>指定が誤っている（ディレクトリ階層と一致しない）場合に、エラーが発生する</li>

<li>導入経緯は <a href="https://github.com/cpprefjp/site/issues/1204" target="_blank">PR#1204</a> を参照</li>

</ul>

</li>

<li>NGワードの検出 (ngword check)<ul>

<li>日本語入力環境における典型的な誤入力・誤変換をエラーとして検知する</li>

<li>具体的な対象ワードリストは<a href="https://github.com/cpprefjp/site/blob/master/.github/workflows/script/ngword_check.py" target="_blank">ngword_check.py</a>を参照</li>

</ul>

</li>

<li>用語の誤った使い方を検出 (defined word check)<ul>

<li>用語の許可した使い方、許可しない使い方を列挙し、許可した使い方以外の使われ方をエラーとして検出する</li>

<li>具体的な用語、許可した使い方、許可しない使い方は、<a href="https://github.com/cpprefjp/site/blob/master/.github/workflows/script/defined_word_check.py" target="_blank">defined_word_check.py</a>を参照</li>

</ul>

</li>

<li>表示崩れする書き方を検出 (display error check)<ul>

<li>箇条書きのインデントが4の倍数でない行をエラーとして検出する</li>

</ul>

</li>

</ul>

</li>

<li>外部リンク切れを検出 (outer link checkアクション)<ul>

<li>日本時間で日曜日の23:30に実行される</li>

<li>外部リンクのページにアクセスできない (ページが消滅したか、一時的にアクセスできない、などの理由) 場合にエラーとなる</li>

<li>エラーが発生した場合は、本リポジトリにissueが発行される</li>

<li>ページが消滅した場合は、代替となるものがあれば差し替え、なければInternet Archiveに変更する</li>

<li>一時的にアクセスできない場合は、時間を置いてアクセスできるようになったらissueを閉じる</li>

<li>海外からのアクセス (GitHub Actions) を拒否しているページもあるため、そのようなページは個別にチェックから外す (<a href="https://github.com/cpprefjp/site/blob/master/.github/workflows/script/link_check.py" target="_blank">link_check.py</a>の<code>IGNORE_LIST</code>に追加する)</li>

</ul>

</li>

</ul>

<h3>自動反映ツール</h3>

<p>自動反映ツールも、GitHub上で開発が進められています。</p>

<ul>

<li><a href="https://github.com/cpprefjp/site_generator" target="_blank">site_generator</a></li>

</ul>

<p>機能要望やpull request等がありましたら、こちらにお願いします。</p>

<h2>編集権限を得るには</h2>

<p>push権限を持っていない方は、pull requestで何らかの編集を行うところからはじめてください。タスクを引き取っていただける場合には、タスクのissueに「やります」とコメントを書いていただければ、担当をお渡しします。</p>

<p>本サイトに対してpull requestを提出していただければ、取り込んだあとに管理者から編集権限をお渡しします。</p>

<p>pull requestに慣れていない場合には、issueでの相談からはじめていただければと思います。</p>

<p>管理者からpush権限をお渡しする申請が届いた場合には、引き受けていただけると幸いです。</p>

<h2>Markdown形式による編集方法</h2>

<p>cpprefjpサイトは、Markdown(.md)形式でリファレンスを記述します。</p>

<p>Markdownは、GitHubサービス上でドキュメントを記述するフォーマットとして広く使用されている形式です。</p>

<p>Markdownの記述方法をわかりやすく解説してくれているWebサイトは、すでに数多く存在しますので、詳細はそちらを参照してください。</p>

<p>ただし、cpprefjp特有の拡張構文もあります。

以下のページにまとめてあるので、そちらを参照して下さい。</p>

<ul>

<li><a href="start_editing/markdown_cpprefjp.html">cpprefjpでのMarkdown記法の制限と拡張</a></li>

</ul>

<p>Markdown形式では、HTMLのタグも併用できますが、cpprefjpサイトでは積極的にはHTMLタグを使用しない方針で、許可されたタグのみ使用できます。できるだけ、Markdown形式でできる範囲内で解決するようにしてください。</p>

<p>ただし、注釈・出典を貼るためにHTMLタグを利用します。</p>

<ul>

<li><a href="start_editing/cite_note_ref.html">cpprefjpにおける注釈・出典の貼り方</a></li>

</ul>

<p>新規リファレンスを書くにあたって、雛形ページを用意していますので、そちらをベースにして編集作業を行ってください。</p>

<ul>

<li><a href="start_editing/lang_template_page.html">言語機能の雛形</a></li>

<li><a href="start_editing/header_template_page.html">ヘッダファイルページの雛形</a></li>

<li><a href="start_editing/module_template_page.html">モジュールページの雛形</a></li>

<li><a href="start_editing/function_template_page.html">関数の雛形</a></li>

<li><a href="start_editing/class_template_page.html">クラスの雛形</a></li>

<li><a href="start_editing/type-type_template_page.html">型の別名の雛形</a></li>

<li><a href="start_editing/concept_template_page.html">コンセプトの雛形</a></li>

<li><a href="start_editing/named_requirement_template_page.html">名前付き要件の雛形</a></li>

<li><a href="start_editing/comparison_operator_template_page.html">比較演算子の雛形</a></li>

<li><a href="start_editing/cpo_template_page.html">CPOの雛形</a></li>

</ul>

<p>また、リポジトリのトップディレクトリに<code>GLOBAL_QUALIFY_LIST.txt</code>というファイルがあります。サイト全体のコードブロックに対して適用したい識別子の修飾があれば、ここに列挙していきます。書き方は各雛形ページに書いてあるコードブロックの修飾と同じです。</p>

<h2>初めての人は見ておいたほうがよいページ</h2>

<ul>

<li><a href="implementation.html">処理系</a> 処理系の正式な定義があります</li>

<li><a href="https://github.com/cpprefjp/site/wiki/progress" target="_blank">進行状況</a> リファレンス作成の進行状況が確認できます</li>

<li><a href="working_style.html">スタイル</a> 作業を行う上でのスタイルの定義と、訳語があります</li>

</ul>

<h2>その他、cpprefjpを編集するにあたってのドキュメント</h2>

<ul>

<li><a href="start_editing/page_names.html">ページファイル名の付け方</a></li>

<li><a href="start_editing/random_figure.html">乱数分布の図を作る方法</a></li>

<li><a href="start_editing/directory_structure.html">ディレクトリ構造</a></li>

</ul>

<h2>Pull Requestのレビューとマージ</h2>

<p>push権限を持っている方は、Pull Requestのレビューとマージもぜひお願いします。</p>

<p>Pull Requestを送っていただいた方には、管理者から後ほどpush権限をお渡しします。権限の譲渡は管理者がする必要がありますが、レビューとマージは、ほかのpush権限保持者がしていただいてかまいません。</p>

<p>Pull Requestのレビューが滞っていた場合、Pull Requestの提出者の方は、cpprefjpのpush権限保持者に対して、個人的にレビューを依頼してもかまいません。push権限保持者がだれかは、以下のページから確認できます：</p>

<ul>

<li><a href="https://github.com/orgs/cpprefjp/people" target="_blank">cpprefjp people</a><ul>

<li>権限保持者の確認に使用できます</li>

</ul>

</li>

<li><a href="https://github.com/cpprefjp/site/graphs/contributors" target="_blank">cpprefjp contributors</a><ul>

<li>各人が本サイトにどれくらいコントリビュートしているかを確認できます</li>

</ul>

</li>

</ul>

<p>ただし可能な限り、レビュアーとの技術的な議論はPull Request上で行っていただけると助かります。これは、議論を記録として残すことが目的です。</p>

<h2>Git関係のルール</h2>

<ul>

<li>コミットメッセージに厳密な書式は設けない<ul>

<li>人によっては「〜を修正」のように書き、またある人は「fix ...」のように書きます。コミットメッセージは修正内容がわかることが大事で、書式はそれほど重要ではないという考えです</li>

<li>また、本リポジトリが、英語の情報を元に日本語情報を提供する、という特性上、コミットメッセージが日本語と英語どちらであっても編集者が困ることはないはずですので、日本語か英語であれば、どちらで書いてもよいものとします</li>

<li>コミットメッセージの内容としては、とくに自分以外の人が書いた文章を編集する際には、コミットメッセージに「なぜそのように編集したのか」をできるだけ書いたほうがよいです。これは、経緯を振り返りやすくすることが目的です</li>

</ul>

</li>

<li>強制プッシュ<ul>

<li><code>git push -f</code>や<code>git push --force</code>といったコマンドは、リポジトリの設定で、masterブランチに対してはできないようにしてあります。これは、masterブランチは壊してはならないという理由によるものです</li>

<li>masterブランチ以外には強制プッシュできますので、Pull Request用のトピックブランチのコミットを整理する、といった目的などで使用していただいて大丈夫です</li>

</ul>

</li>

</ul>

<h2>求められる編集作業</h2>

<h3>誤字・脱字を修正する (難易度★)</h3>

<p>本サイトは編集者が手入力で解説を書いているため、誤字・脱字はどうしても発生してしまいます。</p>

<p>誤字・脱字があったら、積極的に修正してください。</p>

<h3>動作確認できたコンパイラバージョンを記載する (難易度★★)</h3>

<p>本サイトのライブラリリファレンスでは、機能ごとに動作確認ができたコンパイラバージョンを記載しています。</p>

<p>各ページを書いた時点での動作確認できたコンパイラバージョンは記載していますが、その後の更新は十分に行えていません。</p>

<p>サンプルコードの下に以下のように動作確認できたコンパイラバージョンを記載する項目がありますので、「??」になっている項目がありましたら、動作確認して埋めていっていただきたいです。</p>

<p><pre><code>## 処理系

### バージョン

- [Clang](/implementation.md#clang): ??

- [GCC](/implementation.md#gcc): 9, [mark noimpl], 10 [mark verified]

- [Visual C++](/implementation.md#visual_cpp): 2019 Update 1 [mark impl]

</code></pre></p>

<ul>

<li>mark noimpl : 未実装を表す絵文字</li>

<li>mark impl : 動作確認はできていないけど、リリースノートやそれに類するドキュメントには実装済みと書かれていることを表す絵文字</li>

<li>mark verified : 動作検証済み</li>

</ul>

<p>バージョンの表記としては、とくにVisual C++は本サイト独自の表記法がありますので、以下のページを確認してください。</p>

<ul>

</ul>

<p>対応バージョンは、動作確認できたコンパイラのうち、最小のバージョンを知りたいので、記載されているものより古いコンパイラバージョンで動作確認ができた場合は、記載されているバージョンを修正してください。</p>

<p>動作確認の方法としては、対象ページのサンプルコードを、お手元のコンパイラでコンパイル・実行し、出力が記載されているものと一致しているかを確認してください。</p>

<p>ただし、「出力例」のように記載されている場合、プラットフォームごとに出力が異なる可能性があります。その場合は仕様と実装を確認していただく必要があるかもしれません。</p>

<p>動作確認は、Webブラウザ上で行える場合があります。オンラインコンパイラとして、以下のサービスの使用も検討してください。</p>

<ul>

<li><a href="https://wandbox.org/" target="_blank">Wandbox</a></li>

<li><a href="https://godbolt.org/" target="_blank">Compiler Explorer</a></li>

</ul>

<h3>関連項目を追加する (難易度★★★)</h3>

<p>各ページには、「<code>## 関連項目</code>」という見出し以下に本サイト内の関連ページを記載できます。</p>

<p>読者が関連する情報を追いやすいように、関連ページへのリンク追加をお願いしたいです。</p>

<p>関連項目としては、以下のようなものを記載します：</p>

<ul>

<li>言語機能であれば、その機能への仕様変更・拡張など</li>

<li>ライブラリであれば、<ul>

<li>組み合わせて使うことが多いもの</li>

<li>特定のデータ構造に特化した関数と、汎用の関数</li>

<li>その機能の代わりに使用を検討したほうがよいもの</li>

</ul>

</li>

</ul>

<p>関連項目を書く場所については、各雛形ページを参照してください。</p>