apache / apache/pinot

Create documentation on developer guidelines

Open Beginner friendly
#5,578 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
6.1k
Forks
1.5k
Avg merge
2d 55m
Merged PRs (30d)
182

Description

E.g.
- Apply the Pinot code style: `/config/codestyle-intellij.xml` or `/config/codestyle-eclipse.xml`
- Annotate interfaces with `InterfaceAudience`
- Use `_` as the prefix for member variables
- All upper case for constant variables
- Annotate arguments with `javax.annotation.Nullable` if it can be null; by default the argument should not be null
- SuppressWarnings annotation
- VisibleForTesting annotation

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the listed style references, /config/codestyle-intellij.xml and /config/codestyle-eclipse.xml, along with the guideline items in the issue. Create developer documentation covering the code style, annotations, naming conventions, and warning suppression described here. Done means each listed guideline is documented clearly for contributors.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.