basecamp / basecamp/trix

Question: Is the team open to JS-Doc tags being added for better IDE experience.

Open
#1,145 1 comment 3 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
20k
Forks
1.1k
Avg merge
3d 12h
Merged PRs (30d)
13

Description

Describe the bug or issue here…
Not a bug, but a question. I'm a big fan of the team's attitude towards Typescript ;) - I feel like what you guys do here with pure JS is a great example of what's possible.

However, there are some genuinely great developer experience / onboarding benefits to having JS Doc tags for function params / responses, especially considering you guys have already implemented proper models for all your domain entities.

It basically gives you all the DevEx things people rave about TypeScript, with none of the "tax", because it's all just vanilla JS.

I'd be curious about doing some of the tagging myself as a way of learning how the editor works in-detail, but I obviously don't want to waste my time if it's something the team isn't interested in having in the project.

Contributor guide

No contributing guide indexed for this repository

Research direction

The proposal concerns JSDoc tags for function parameters and responses in the JavaScript editor, especially the existing domain entity models. First confirm whether the team wants this direction and determine the scope of functions to annotate. Done would mean an agreed annotation plan, but the issue does not identify files or tests to use.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
developer-experience
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.