palantir / palantir/conjure-java

Enforce best practices

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

Nobody has claimed this yet.

Dominant language
Java
Stars
39
Forks
49
Avg merge
8h 22m
Merged PRs (30d)
32

Description

What happened?

I have recently figured out that having an endpoint return a primitive value (even if it's behind an alias) is a really bad design choice, since it means the endpoint return value can never be extended. I suspect there might be a lot of these things that people have found, I was wondering if we could collect and enforce those learnings.

What did you want to happen?

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 identify any files, tests, or entry points. First clarify which best practices should be enforced and where endpoint return types are defined; done criteria are not yet specified.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.