Skip to content

Navigation Menu

Sign in
Sign up

trax Discussions — Posting Guidelines & Templates #3

Pinned
Discussion options

trax Discussions — Posting Guidelines & Templates

Please follow these guidelines so Discussions stay useful and welcoming.

Be respectful

  • Treat others with respect. No harassment, discriminatory language, or personal attacks.
  • Keep language professional and constructive.

Search first

  • Check existing Discussions and Issues before posting to avoid duplicates.

Write useful posts

  • Use a clear title and pick the correct category.
  • Include relevant context: trax version, environment (OS, runtime), config, and steps to reproduce for support.

Support template (use for "Help & Support")
Title: [Support] Short description of the problem
Body:

  • trax version:
  • Environment (OS, runtime, browser, etc.):
  • What I did (steps):
  • What I expected:
  • What happened (error messages, logs, stack traces):
  • Minimal reproduction (code snippet or link to a minimal repo):

Feature request template (use for "Feature Requests")
Title: [Feature] Short description of the feature
Body:

  • Summary: one-sentence summary of the feature
  • Problem this solves / Use case:
  • Proposed solution or API/UX:
  • Alternatives considered:
  • Backward compatibility concerns:
  • Is this something you can help implement? (yes/no)

Moderation and enforcement

  • Maintainers and selected moderators can pin/move/close Discussions.
  • Off-topic/duplicate/rude posts may be locked or removed.
  • To report abuse or private concerns, open a confidential Issue addressed to maintainers, or mention a maintainer in the repo’s issue tracker.

Thread housekeeping

  • Moderators may convert Discussion threads into Issues for actionable work.
  • Mark threads resolved if there is a clear resolution (or add a summary reply).
  • Keep long-running design threads focused; consider summarizing decisions periodically.

Private data & security

  • Do not post secrets, API keys, or personal data.
  • If you discover a security vulnerability, report it via the repository's security policy or open a private security issue.

Language & accessibility

  • English is the default language for public threads; keep sentences short and clear to help non-native speakers.
  • Use code blocks for code and paste logs as text rather than screenshots when possible.

Minimal moderation roles to assign (recommended)

  • 1–2 maintainers as moderators to review new posts
  • A triage rotation for handling support requests and moving duplicates into canonical threads
You must be logged in to vote

Replies: 0 comments

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
1 participant

AltStyle によって変換されたページ (->オリジナル) /