No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
java
js
jsp
shell
sql
.gitignore
.textlintrc
CHANGELOG.md
README.md
package-lock.json
package.json

README.md

Nablarchスタイルガイド

本リポジトリではJavaをはじめとする各言語のコーディング規約と、Checkstyle・SpotBugsといった静的解析ツールの導入ガイドを提供します。

ライセンス


本リポジトリ内のドキュメントはクリエイティブ・コモンズ 表示 - 継承 4.0 国際 ライセンスの下に提供されています。

また次に示すファイルやサンプルプロジェクトは Apache License Version 2.0 の下に提供されています。

  • Javaコードフォーマッター
  • java/staticanalysis/checkstyle/checkstyle-example/ 以下に格納されているサンプルプロジェクト
  • java/staticanalysis/spotbugs/spotbugs-example/ 以下に格納されているサンプルプロジェクト

スタイルガイドをカスタマイズする

本リポジトリではプロジェクトを進めるにあたってすぐに使えるよう過不足の無いガイドを提供しているつもりですが、プロジェクトによっては更に規約を追加したかったり、反対に不要な規約を削除したかったりするでしょう。

そのような場合は、本リポジトリをコピーして自由にカスタマイズをしてください。

プロジェクトがGitHubを使用している場合と、社内に立てたGitリポジトリを使用している場合に分けて、カスタマイズの方法を解説します。

GitHubでforkしてカスタマイズする

プロジェクトがGitHubを使用している場合のカスタマイズ方法について解説します。

まず、本リポジトリをforkしてください。 本リポジトリの右上にforkと書かれたボタンがあるので、そちらを押してforkしてください。

forkして新しく作成されたリポジトリに対してカスタマイズを加えてください。

プロジェクトが持つ社内のGitリポジトリへコピーしてカスタマイズする

プロジェクトがGitHubを使用しておらず、社内にGitリポジトリを立てている場合のカスタマイズ方法について解説します。 ここでは例としてプロジェクトがGitBucketを使用しているとします。

まず、社内のGitBucket上で空のリポジトリを作成してください。 ここではnablarch-style-guideという名前で空のリポジトリを作成したとします。

次に、本リポジトリをcloneしてください。

git clone https://github.com/nablarch-development-standards/nablarch-style-guide.git

cloneして出来たローカルリポジトリへ、社内のGitBucketへ作成した空のリポジトリをリモートリポジトリとして追加します。

git remote add intra http://localhost:8080/git/example-group/nablarch-style-guide.git

最後に、追加したリモートリポジトリへpushします。

git push intra master

これで本リポジトリの内容が社内のGitBucket上に作成したリポジトリへコピーされました。 コピーしたリポジトリに対してカスタマイズを加えてください。

バージョンについて

本スタイルガイドのバージョンはメジャーバージョンとマイナーバージョンをピリオドで繋いだもので表されます。 新たな言語のスタイルガイドを追加した場合や、Javaコーディング規約などに新たな項目が追加された場合にメジャーバージョンがインクリメントされます。 誤字脱字の修正や、意味はそのままに表現を変更した場合はマイナーバージョンがインクリメントされます。

変更履歴はCHANGELOG.mdを参照してください。