Ideas for J2V8 project improvement

[aschrijver]

This issue is a discussion thread for J2V8 project improvement and is part of Future direction and vision of the J2V8 project.

Below is a list of action points that I'll maintain based on your ideas, suggestions and feedback.

(Ideally suggestions should be made on a J2V8 chat channel, and only actionable items discussed here)

Goals

• Stable technology foundation to build production-ready products and solutions
• Vibrant, productive open-source community keeping J2V8 up-to-date and relevant

---

Ideas

project structure

• new github organization 'J2V8'
  • j2v8 - landing page j2v8.org, docs, ecosystem, community, blog, showcases (gh-pages)
  • j2v8-core - core module (this project, unless moved to Eclipse)
  • j2v8-test - test module (base classes + utilities to ease testing)
  • j2v8-build - the build system separated from the code in j2v8-core
  • j2v8-template - template for new module repositories (see next paragraph)
  • j2v8-java-interop - a sub module repo (e.g for Add support for sharing Java classes across the J2V8 bridge #201))
  • j2v8-awesome - github awesome page for entire J2V8 ecosystem overview

repository template

• self-contained, stand-alone j2v8 code repositories
  • comprehensive README structure
  • continuous integration (TravisCI)
    • for code
    • for documentation (aggregation in j2v8.org/docs)
    • for docker hub
    • for maven artifacts (e.g. Bintray)
  • auto-generated API documentation
  • auto-generated user documentation (e.g from package-info.java, see vertx-docgen)
  • running example code (used in documentation code snippets)
  • code analysis, code coverage (e.g. Codacy)
  • unit testing
  • integration testing
  • performance, security, etc. testing

community

• J2V8 chat channel, see: Create a chat channel for J2V8 #331
• at least 3 community maintainers for j2v8 organization main repositories
• community guidelines
  • licensing
  • contribution guidelines
  • code of conduct
  • coding style
  • documentation style
  • github issue guidelines (displays in 'New issue' body)
  • github PR guidelines (displays in 'New PR' screen)