apache / apache/maven-site

Missing conventions

Open
#1,354 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Java
Stars
123
Forks
301
Avg merge
16h 59m
Merged PRs (30d)
32

Description

### Improvement proposal

The convention pages have the following TODOs

Code Conventions

* Javadoc
* APT - but as we are migrating, I think we can skip this
* Added by me: The import order only speaks of javax. I think this is useless nowadays with jakarta in place. My suggestion: Handle both, jakarta as well as javax, as any other 3rd party

Git:
* Gitingore

Contributor guide

No contributing guide indexed for this repository

Research direction

Locate the convention pages referenced in the issue and review their TODOs, especially the Code Conventions and Git sections. Check the existing guidance for Javadoc, APT, import ordering, and Git ignore rules. Done means the selected TODOs are addressed in the relevant convention pages, with the javax/jakarta recommendation resolved consistently.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.