Konstantin Gribov created TIKA-2316:
---------------------------------------
Summary: Write something like contribution guide in wiki and/or
site
Key: TIKA-2316
URL: https://issues.apache.org/jira/browse/TIKA-2316
Project: Tika
Issue Type: Improvement
Reporter: Konstantin Gribov
Things to mention there:
- formatting guidelines (e.g. 4 spaces, no tabs, no commented imports etc);
- logging guidlines (like use of {{private static final Logger LOG}}, use SLF4J
message interpolation instead of string concat etc);
- mention dependencies policy (like no deps in {{tika-core}}).
Some parts are altready documented
[here|http://tika.apache.org/contribute.html] but they could be extended.
One idea is to add checkstyle support (via {{maven-checkstyle-plugin}}) and
require {{mvn clean validate}} pass for merging. Also, it would be even better
to also document how to configure checkstyle in IDEs.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
