Skip to content

Add CONTRIBUTING guide and surface contributor onboarding from README#31

Merged
harumiWeb merged 2 commits intomainfrom
copilot/add-contributing-md-and-setup-guide
Apr 6, 2026
Merged

Add CONTRIBUTING guide and surface contributor onboarding from README#31
harumiWeb merged 2 commits intomainfrom
copilot/add-contributing-md-and-setup-guide

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 6, 2026

This PR adds a minimal contributor guide so first-time contributors can find setup, contribution policy, and pre-PR expectations without digging through README and CI config. It also adds an explicit README entry point to reduce onboarding friction.

  • Contributor entry point

    • Add root-level CONTRIBUTING.md
    • Link to it from both README.md and README.en.md
  • Contribution policy

    • Clarify that bundled core vocabulary additions are not accepted as PRs
    • Call out that fixes to already-registered vocabulary data are welcome
    • Set expectation that maintainer response time may vary
  • Development setup

    • Document required tooling and versions for normal development vs. dictionary pipeline work
    • Include clone / initial setup commands
    • Document how to enable lefthook
  • PR workflow expectations

    • Define when contributors should open an issue first
    • Clarify that small docs / typo / narrow fixes can go straight to PR
    • Set expectations for branch naming, commit scope, and PR descriptions
  • Quality gates

    • Centralize the minimum pre-PR commands for format, lint, tests, and build
    • Call out the extra shellcheck requirement when install.sh changes
  • Change-specific review notes

    • Add short guidance for TUI changes
    • Add cautions for dictionary/data changes and license-sensitive files
    • Add reminders for release/distribution-related edits

Example of the documented local quality checks:

goimports -w cmd internal assets
golangci-lint run
go test ./...
go build ./...

Open with Devin

@codacy-production
Copy link
Copy Markdown

codacy-production bot commented Apr 6, 2026

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

TIP This summary will be updated as you push new changes. Give us feedback

Agent-Logs-Url: https://github.com/harumiWeb/eitango/sessions/2fbd1f20-540d-4f2f-a419-3c7e5aa2493c

Co-authored-by: harumiWeb <164025931+harumiWeb@users.noreply.github.com>
Copilot AI changed the title [WIP] Add CONTRIBUTING.md and setup guide Add CONTRIBUTING guide and surface contributor onboarding from README Apr 6, 2026
Copilot AI requested a review from harumiWeb April 6, 2026 22:43
@harumiWeb harumiWeb marked this pull request as ready for review April 6, 2026 22:53
Copy link
Copy Markdown

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@harumiWeb harumiWeb merged commit bce102e into main Apr 6, 2026
8 checks passed
@harumiWeb harumiWeb deleted the copilot/add-contributing-md-and-setup-guide branch April 6, 2026 23:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: CONTRIBUTING と開発環境セットアップ導線を整備する

2 participants