Back to Home Security Release Notes GitHub

Contributing Guide

We welcome bug fixes, test improvements, documentation updates, and feature proposals. Keep changes scoped and easy to review.

1. Scope

Bug fixes
Tests and quality improvements
Documentation updates
Feature proposals

2. Development Setup

Backend:

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

Full stack with Docker (recommended):

cd app
./start_docker.sh pg up

3. Branch and Commit

Create a feature branch from main
Keep commits small and logically grouped
Use clear commit messages: feat:, fix:, docs:, refactor:, test:

4. Pull Request Checklist

Change scope and intent are clearly explained
Relevant tests were run
API/behavior changes are documented
Screenshots are attached for UI changes
Security/privacy impact is considered

5. Coding Rules

Keep comments and docstrings in English
Keep user-facing UI text in Japanese for this project
Avoid unrelated formatting-only changes in large files
Do not commit secrets (.env, API keys, credentials)

6. Issue First for Large Changes

For large features/architecture changes, open an issue and align on:

Problem statement
Proposed approach
Risks and migration impact

7. License

By contributing, you agree that your contributions are provided under the repository license.