Skip to content

Commit

Permalink
docs(contributing): cover discussions
Browse files Browse the repository at this point in the history
  • Loading branch information
privatenumber committed Apr 8, 2024
1 parent 1a10da7 commit 5dfc7fd
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Welcome! We're excited you're interested in contributing. To ensure a smooth and
2. Improve ESM ↔ CommonJS interoperability as the ecosystem migrates to ESM
3. Support the [active LTS versions of Node.js](https://endoflife.date/nodejs)

## Issues
## Issues & Discussions

> [!IMPORTANT]
> Please be polite, respectful, and considerate of people's time and effort.
Expand All @@ -25,7 +25,7 @@ Provide a clear, minimal example of the issue. This helps contributors identify

Review the project documentation for known behaviors or caveats to avoid unnecessary issues.

### Commenting on an existing Issue
### Commenting on an existing Issue/Discussion

#### ⭐️ Issue objectives

Expand All @@ -37,17 +37,17 @@ Issues serve as a platform for **contributors** to:

#### ✅ Be constructive

Aim to contribute to the solution with research & PRs (tests + solutions).
Aim to contribute to the solution with research & PRs (tests + solutions). The goal is to land an improvement in tsx for everyone to benefit.

Be concise to save people's time.

#### ❌ Avoid detractive comments

Keep comments focused on fixing the issue.

Comments like "updates?", "also happening in ...", or discussing workarounds will be hidden.
Off-topic comments, comments that don't add value (e.g. "updates?", "also happening in ..."), and discussing workarounds will be hidden or deleted.

Issues may be locked post-verification to direct further conversation & action to PRs.
After an issue is confirmed, the thread may sometimes be locked to direct further conversation & action to PRs.

> [!TIP]
> **⚡️ Get issues addressed faster!**
Expand All @@ -58,7 +58,6 @@ Issues may be locked post-verification to direct further conversation & action t
## Pull requests


#### Open an Issue first

Ensure there’s an existing issue related to your PR to facilitate alignment and prevent wasted work.
Expand Down

0 comments on commit 5dfc7fd

Please sign in to comment.