Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

All but one alias should be deprecated

Open
#47 2 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript
Domain
tooling

Research direction

Start by inventorying alias groups under model/attributes, using the code.filepath and code.file.path definitions as the example pattern. Review the listed AI, HTTP, URL, and release aliases, decide which name remains preferred in each group, and mark the others deprecated. Done means every alias group has one undeprecated name; a lint or CI check is an optional further enforcement step.

Written by the indexing model from the issue text.

Description

Improvement

Currently this repository can contain more than one name for a single concept. It would be ideal if, for any given set of aliases, a single name was always identifiable as the preferred alias. (In other words, if all but one alias was always marked deprecated):

  • For an SDK engineer or user implementing performance instrumentation, they don't have to make a judgement call over which alias to use
  • For a product engineer wanting to start using a particular value programmatically, they know what key to read during ingestion, use in saved searches, call from the frontend, etc (as well as all the deprecated aliases needing coalescing or copying)

An example where all but one alias is deprecated ✅

Examples where more than one alias is undeprecated ❌

  • ai.completion_tokens.used, gen_ai.usage.output_tokens
  • ai.input_messages, gen_ai.prompt
  • ai.model_id, gen_ai.response.model
  • ai.prompt_tokens.used, gen_ai.usage.input_tokens
  • http.response.body.size, http.response.header.content-length
  • http.route, url.template
  • params.<key>, url.path.parameter.<key>
  • sentry.release, service.version

So, my ask would be to identify every group of aliases, and mark all but one deprecated. Even better would be a lint or CI step that enforced this.

Dominant language
TypeScript
Stars
16
Forks
7
Avg merge
2d 9h
Merged PRs (30d)
63

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from getsentry/sentry-conventions

All issues in getsentry/sentry-conventions

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.