Github user ajs6f commented on the pull request:
https://github.com/apache/jena/pull/58#issuecomment-101273013
I don't think you owe me any apologies. It's just a case of a new guy
showing up to an open source project who has to spend some time getting to know
the rhythm before joining the dance.
It definitely sounds like some effort at "codification" (in the lightest
and gentlest sense) would better repay than more wrangling on the code itself.
It might benefit other latecomers, and if it seems to be getting bogged down in
minutia or dogmatism, we can just cut it short and take forward whatever _was_
learnt.
I'll shoot something to dev@ today. Here is a strawman:
It would be nice to have some rough code standards that would help
newcomers without inhibiting anyone from contributing. Possible simple policies
include:
- Don't throw checked exceptions that aren't really ever thrown unless an
API supertype specs it.
- Don't leave unused imports in. Any IDE can solve that problem for you
with one keystroke.
- If a type declares a supertype that isn't a required declaration,
consider whether that clarifies or confuses the intent. The former is okay, the
latter not so good.
- Minimize the compiler warnings your code throws up. If you use
`@SuppressWarnings` to hide them, please add a comment explaining the situation
or a TODO with a potential future fix that would allow removing the suppression.
- Please remove unused local variables or fields or uninteresting private
methods. If it's debugging detritus, consider adding formal logging code for
future use, if it seems likely to be useful.
- If there is valuable code in some unused private method, add a
`@SuppressWarnings` with an explanation of when it might become useful. If
there is valuable but "dead" code inside a "live" method, consider breaking it
out into a private method and adding `@SuppressWarnings` and explanation.
After discussion on the list and assuming that goes well, I'll take it to
the CMS and to a ticket to start getting some feedback from Checkstyles from
actual processing of the code. If Jena has some public CI, it would be great to
get something like [Sonar](http://www.sonarqube.org/) engaged there for
telemetrics.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
