Skip to content

SUPPORT.md

Latest commit

 

History

History
89 lines (60 loc) · 2.67 KB

SUPPORT.md

File metadata and controls

89 lines (60 loc) · 2.67 KB
Raw

Support

How to Get Help

Choose the most appropriate channel below based on your needs.

📚 Documentation

Resource Description
README Project overview, quick start, and CLI reference
中文 README Chinese documentation
Architecture Decision Records ADRs explaining why decisions were made
Design Docs How features are implemented
AGENTS.md Development conventions and engineering rules

🐛 Issues & Bugs

Use GitHub Issues for:

  • Bug reports (use the Bug Report template)
  • Feature requests (use the Feature Request template)
  • Questions about usage (use the Question template)

Before opening a new issue, please:

  1. Search existing issues to avoid duplicates.
  2. Use the --debuglog flag to collect diagnostic information.
  3. Include the JoinCode version, OS, and .NET SDK version in your report.

💬 Discussions

For general discussion, ideas, and community Q&A, use GitHub Discussions (if enabled) or open an issue with the Question template.

🔒 Security Issues

See SECURITY.md. Do not open public issues for security vulnerabilities.

Common Issues

Build Fails with "MSB3027: Exceeded retry count"

Another dotnet build or testhost process is holding a lock on build artifacts. Kill stale processes and retry:

Get-Process -Name testhost -ErrorAction SilentlyContinue | Stop-Process -Force
dotnet build App.slnx -c Debug

NativeAOT Compilation Fails on New [Register] Types

Source generators cache output during incremental builds. After adding or modifying [Register] classes, rebuild with --no-incremental:

dotnet build Generators.slnx -c Release --no-incremental

jcc Hangs in Interactive Mode

Use the non-interactive mode with a timeout for debugging:

jcc --trust --await 20 -p "your prompt here"

If the process times out (exit code 1234), run with --debuglog to capture diagnostic traces.

Filing a Good Bug Report

A great bug report includes:

  1. Summary: One-sentence description of the problem
  2. Reproduction steps: Minimal sequence to trigger the bug
  3. Expected vs. actual behavior
  4. Environment: OS, .NET SDK version, JoinCode version
  5. Logs: Output from --debuglog (trim sensitive data first!)

Contributing

See CONTRIBUTING.md for how to contribute code, documentation, or fixes.