You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tika.apache.org by "Konstantin Gribov (JIRA)" <ji...@apache.org> on 2017/03/29 17:42:41 UTC
[jira] [Updated] (TIKA-2316) Write something like contribution
guide in wiki and/or site
[ https://issues.apache.org/jira/browse/TIKA-2316?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Konstantin Gribov updated TIKA-2316:
------------------------------------
Description:
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.
[Discussion thread on dev@|https://lists.apache.org/thread.html/48dfb410e690742ab3e0264178bff8cec6d93d2c39c76868200900fc@%3Cdev.tika.apache.org%3E].
was:
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.
> 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.
> [Discussion thread on dev@|https://lists.apache.org/thread.html/48dfb410e690742ab3e0264178bff8cec6d93d2c39c76868200900fc@%3Cdev.tika.apache.org%3E].
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)