Github user nickwallen commented on the issue:

    https://github.com/apache/incubator-metron/pull/234
  
    Putting exactly this sort of description as javadoc for every class that 
you create would be very much appreciated.  
    
    I feel I spend too much effort tracing through Metron code and guessing as 
to what it is doing.  Effort that would be avoided with a few well-placed 
comments and javadocs.
    
    We need to minimize barriers for contributors. Its very difficult for 
others to contribute if we don't spend significant effort to document and 
comment that code that we are creating.   I think in general this is one thing 
that we need to significantly improve upon on with Metron.
    



---
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.
---

Reply via email to