Skip to content

Latest commit

 

History

History
46 lines (23 loc) · 2.81 KB

start_editing.md

File metadata and controls

46 lines (23 loc) · 2.81 KB

boostjpを編集するには

本boostjpサイトのコンテンツは、GitHubリポジトリにあるMarkdown形式のプレーンテキストで行います。

boostjpサイトのGitHubリポジトリは、以下になります:

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

編集権限を得るには

編集権限は現在のコミッタに与えてもらうか、pull requestしてコミッタに修正を取り込んでもらうかする必要があります。

旧boostjpサイトで編集を行っていた方には、優先的に編集権限をお渡しします。

以下のページに載っているコミッタの人たちの誰かにコンタクトをとってもらうか、boostjp/siteリポジトリのIssue報告として、編集権限の申請を行ってください。

コミッタから直接お誘いに行く場合もありますので、快く引き受けていただければ幸いです。

boostjpサイトの編集に慣れていない方は、pull requestからでもぜひ始めてみてください。これは、編集権限を得るための審査ではなく、編集の練習のためだと考えてください。pull requestを何回かいただければ、継続して活動していただけるものと判断し、編集権限をお渡しします。

Markdown形式による編集方法

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

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

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

Markdown形式では、htmlのタグも併用できますが、boostjpサイトでは積極的にはhtmlタグを使用しない方針です。できるだけ、Markdown形式でできる範囲内で解決するようにしてください。

編集に際してのその他の方針、ガイドライン

編集に際してのその他の方針については、cpprefjpの編集方針及びはじめてのコントリビュートをご覧ください。