組織内でのナレッジの共有

開発組織を成長させるナレッジ共有

プロジェクト固有のナレッジをチームに共有したいと思いませんか？共有したいナレッジは、コードのパターンと共に設定ファイルとしてリポジトリに含めましょう。パターンにマッチするコードがプロジェクトにプッシュされると、Siderはそれを自動で検知し、チームメイトに知らせることで共有を図ります。

紹介ビデオ（英語）

Ruby
PHP
Java
TypeScript
General

Highlighted by Sider

querly.yml

rules:
  - id: com.example.app.migration_operation
    pattern:
      - create_table
    message: |
      Get ready for migration!

      Read the operation manual for DB migration.
      - https://docs.example.com/app/migrations

Highlighted by Sider

phinder.yml

- id: com.example.security.oauthToken
  pattern: "?->oauthToken()"
  message: |
    OAuth token is a credential

    Make sure to not expose the value to users or logs.
    Use `->filteredOAuthToken()` for obfuscated tokens.

Highlighted by Sider

javasee.yml

- id: java.date
  pattern:
    - new Date(...)
  message: |
    We recommend not using `Date` class

    Use _Date and Time API_ introduces in Java8,
    which provides immutable and rich classes including
    `LocalDateTime` and `ZonedDateTime`.

Highlighted by Sider

tyscan.yml

- id: anchor_without_href
  pattern: '<a !href>'
  message: |
    Try using `Button` component instead of an anchor

    When you want a button, which responds to users' click,
    please use `Button` component.
    An `a` tag should only be used for navigations between URLs.

Highlighted by Sider

goodcheck.yml

rules:
  - id: review.sider.wording.signin
    pattern:
      - token: Log in
        case_sensitive: false
      - token: Log out
        case_sensitive: false
    glob:
      - "**/*.html.erb"
      - "**/*.yml"
    message: |
      Please use "sign in" or "sign out"

      We use "sign in" instead of "log in" and "sign out" instead of "log out".
      See the wording policy for details.

      https://docs.example.com/1840
    fail:
      - "Log in"
      - "Log out"
    pass:
      - "Sign in"
      - "Sign out"

解析ツールの一覧

最適なツールを選択しましょう

開発プロジェクトにて利用しているプログラミング言語に応じて、Querly、Phinder、JavaSee、TyScanの中から適切なツールを選びましょう。これらのツールは、サポートするプログラミング言語の構文に対応した様々なパターンによってルールを記述できるので、高い精度で対象のコードを検出できます。Goodcheckは正規表現に基づいたパターンでルールを記述します。プログラミング言語を限定せずに、テキストファイルであればどのようなファイルでも検査することができます。

Goodcheck

General

GitHub Tutorial

Querly

Ruby

GitHub Tutorial

Phinder

PHP

GitHub Tutorial

JavaSee

Java

GitHub

TyScan

TypeScript

GitHub

カスタムルールの活用方法を他のチームから学ぶ

サービス運営の経験をルールにし、Siderに蓄積して共有

導入事例を見る

Querlyは「8割くらい修正しない」程度のバランスでいい。

導入事例を見る

他の導入事例を読む

完璧なGitHub/GitLabとの連携

Siderでワークフローを改善しましょう

CODE
PULL
Sider
FIX
MERGE

1. ソースコードを修正

いつものエディタと開発ツールでソースコードを変更しましょう。プロジェクトにpushして、コードレビューの開始です。

2. プルリクエストを作成

新しくプルリクエストを作成すると、Siderが変更点のレビューを開始します。変更部分のみがレビュー対象となるので、古いコードが膨大な量の警告を出してしまう……といった心配はありません。

3. Siderが解析・GitHub/GitLabに結果を表示

解析が完了すると、プルリクエストの状態として結果が報告されます。とても見やすく、見逃すことはありません。

4. Sider上で詳細を確認・対処

検出された問題をSiderで確認します。問題を修正して新しいコミットをpushするか、修正せずにcloseすることもできます。

5. 最後にユーザーがレビュー・マージ

最後にユーザーがレビューしてマージします。一般的な問題はSiderによって既に処理されているので、レビュアーはより本質的な問題の発見に集中できます。

主要な解析ツール
20以上の解析ツールに対応し、標準的なコーディング規約・ベストプラクティスを幅広くサポートします。
セキュリティ
それぞれの解析は隔離された環境で実行されます。Dockerコンテナ内で実行され、第三者があなたのコードにアクセスすることはできません。
スムーズな初期設定
テストモードを利用すると、開発プロセスを邪魔することなくSiderを導入できます。設定が完了したらテストモードを解除してください。
自由度の高いカスタマイズ
Siderはカスタマイズの自由度が高く、既存の設定ファイルをそのまま利用することができます。
すぐに使えるデフォルト設定
Siderが提供しているデフォルト設定を使って、リポジトリを登録してすぐに開発プロセスを効率化することが可能です。
Slackへの通知
解析が終了したら、Slackに自動で通知します。開発者はブラウザを開いて完了を待つ必要がありません。
技術者によるサポート
Siderと解析ツールを熟知したサポートチームが、導入やトラブルシューティングをお手伝いします。
トラブルシューティングも簡単
解析時のログを確認できるので、自分で簡単にトラブルシューティングが可能です。
GitHub/GitLabと連動した権限管理
GitHub/GitLabの権限設定はSiderに反映されます。サインアップの直後から、パーミッションは適切に設定されています。