Skip to content

Contribution Guide

Thank you for your interest in contributing to the navara project. This guide explains the methods and procedures for contributing to the project.

To set up the development environment for each library, please refer to the README of the corresponding GitHub repository. Each repository contains detailed setup instructions and local development methods.

  • Check whether a related Issue already exists, and create a new one if it does not
  • Fill in the required information in the Issue using the template
  • Discussing the changes in advance enables more efficient development
  1. Fork the repository and create a new branch
  2. Implement your changes and add appropriate tests
  3. Verify that code style and linting rules are followed
  4. Write clear and descriptive commit messages
  • Clearly describe the summary and purpose of the changes
  • Reference the related Issue number
  • Attach test results and screenshots (if applicable)
  • Respond promptly to feedback from reviewers

Improvements to this documentation site are also very welcome:

  • Fixing typos: Even small corrections are greatly appreciated
  • Adding or updating content: Adding new information or more detailed explanations
  • Translation: Translating from English to Japanese, or vice versa
  • Adding examples: Adding code samples and usage examples
  1. Create an Issue or PR in the documentation repository
  2. Clearly describe the changes
  3. If possible, attach before-and-after screenshots