Skip to main content
`Ctrl`+`K`

# 12. How to contribute to groonga

We welcome your contributions to the groonga project. There are many ways to contribute, such as using groonga, introduction to others, etc. For example, if you find a bug when using groonga, you are welcome to report the bug. Coding and documentation are also welcome for groonga and its related projects.

As a user:

  If you are interested in groonga, please read this document and try it.

As a spokesman:

  Please introduce groonga to your friends and colleagues.

As a developer: Bug report, development and documentation

  This section describes the details.

- 12.1. How to report a bug
  - 12.1.1. Submit a bug to the issue tracker
  - 12.1.2. Report a bug to the mailing list
- 12.2. How to contribute in documentation topics
  - 12.2.1. Introduction
    - 12.2.1.1. How to fork and clone Groonga repository
    - 12.2.1.2. Install dependent software
    - 12.2.1.3. Run `cmake` with `--preset=doc`
    - 12.2.1.4. Generate HTML
    - 12.2.1.5. How to edit documentation
    - 12.2.1.6. How to add a new documentation
    - 12.2.1.7. Preview changes on HTML files
    - 12.2.1.8. Send patch
    - 12.2.1.9. Optional: Translate documentation
  - 12.2.2. I18N
    - 12.2.2.1. Translation flow
    - 12.2.2.2. How to install Sphinx
    - 12.2.2.3. How to clone Groonga repository
    - 12.2.2.4. How to update `.edit` files
    - 12.2.2.5. How to edit `.edit`
    - 12.2.2.6. How to update `.po` files
    - 12.2.2.7. How to generate HTML files
    - 12.2.2.8. How to confirm HTML output
    - 12.2.2.9. How to send your works
    - 12.2.2.10. How to add new language
  - 12.2.3. C API
    - 12.2.3.1. How to write
    - 12.2.3.2. How to preview
- 12.3. For Groonga developers
  - 12.3.1. Repository
  - 12.3.2. How to build Groonga at the repository
    - 12.3.2.1. How to build Groonga at the repository by CMake on GNU/Linux or Unix
    - 12.3.2.2. How to build Groonga at the repository by CMake on Windows
  - 12.3.3. Groonga 通信アーキテクチャ
    - 12.3.3.1. GQTPでのアーキテクチャ
  - 12.3.4. ユーザーと協力して開発をうまく進めていくための指針
    - 12.3.4.1. Twitter編
  - 12.3.5. クエリの実現
    - 12.3.5.1. クエリ実行のためのインタフェース
    - 12.3.5.2. grn_exprで表現できるクエリ
    - 12.3.5.3. grn_table_select()
    - 12.3.5.4. 関係式
  - 12.3.6. クエリの実例
    - 12.3.6.1. 検索例1
    - 12.3.6.2. 検索例2
    - 12.3.6.3. 検索例3
    - 12.3.6.4. 検索例4
  - 12.3.7. リリース手順
    - 12.3.7.1. 前提条件
    - 12.3.7.2. 最初の1回だけ行う手順
    - 12.3.7.3. 毎回のリリースで行う手順
  - 12.3.8. テスト方法
    - 12.3.8.1. テスト環境の構築
    - 12.3.8.2. テストの動作
    - 12.3.8.3. カバレッジ情報
    - 12.3.8.4. 様々なテスト
    - 12.3.8.5. 静的解析