8. How to contribute to Mroonga — Mroonga vmrn_version documentation

Skip to main content
`Ctrl`+`K`

# 8. How to contribute to Mroonga

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

As a user:

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

As a spokesman:

  Please introduce Mroonga to your friends and colleagues.

As a developer: Bug report, development and documentation

  This section describes the details.

- 8.1. How to report a bug
  - 8.1.1. Submit a bug to the issue tracker
  - 8.1.2. Report a bug with the other ways
- 8.2. How to collect data for reporting a reproducible bug
- 8.3. How to contribute in documentation topics
  - 8.3.1. The things you must do at first
    - 8.3.1.1. Git configuration
    - 8.3.1.2. Fork on GitHub
    - 8.3.1.3. Initial configuration for working repository
    - 8.3.1.4. Prerequisites
    - 8.3.1.5. Required software
    - 8.3.1.6. Initial configuration for building documentation
  - 8.3.2. The things you need to do every tasks
    - 8.3.2.1. Follow the upstream
  - 8.3.3. The things you need to do every files
    - 8.3.3.1. Create working branch
    - 8.3.3.2. Editing text
    - 8.3.3.3. Confirm generated document
    - 8.3.3.4. Commit
    - 8.3.3.5. Push and pull request