square / square/wire

Add the @Generated annotation

Open
#807 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Kotlin
Stars
4.4k
Forks
627
Avg merge
3d 15m
Merged PRs (30d)
20

Description

If we add this annotation to a class, we give a signal that we didn't write this code ourselves.
If we then (for example) push this code to Sonarqube, they won't give any errors on generated code that we can't change.

https://docs.oracle.com/javase/8/docs/api/javax/annotation/Generated.html

Contributor guide

Open the contributing guide

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.

Research direction

The issue does not name files, generated classes, or tests. Start by locating Wire's code-generation entry points and review the linked Java @Generated API; done should mean the relevant generated output carries the annotation and tests cover it.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, kotlin
Domain
devtools
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.