Java

The Rules for Java code are encoded in the 2 attached format profiles for Eclipse.

AsterixCodeFormatProfile.xmlAsterixCleanupFormatProfile.xml

 

The template are automatically applied as part of the build process during the process-sources phase.

The process-sources phase can be invoked individually by running

mvn process-sources -Drat.skip

where -Drat.skip is not required, but helpful to accelerate the process.

 

XML

For XML the rules are

  • no tabs and
  • 4 spaces indentation.

Commit Messages

  • Reference the ticket number on the subject line, but describe the actual change, not just 'Fixed'. Sometimes this is the only comment that is shown for a commit (e.g. for "git log --pretty=oneline"). Try to stay under around 50 total characters.

  • Mention the components affected by the change.
  • List if there are changes to
    • the user model changes (e.g. modification of SQL++ language syntax or HTTP APIs)
    • the storage format (i.e. an earlier version of AsterixDB would not be able to read the current data)
    • interfaces (i.e. code that depends on the current interfaces would break)
  • Leave a blank line after the subject line.
  • Use lines of 77 characters or less for the remaining description.
  • No tabs.

Current list of components (from the AsterixDB JIRA project):

  *DB  - AsterixDB
  HYR  - Hyracks
  
  API  - HTTP API
  AQL  - Translator AQL
  CLUS - Cluster management/communication
  COMP - Compiler
  CONF - Configuration
  DOC  - Documentation
  EXT  - External data
  FAIL - Failure handling/reporting
  FUN  - Functions
  IDX  - Indexes
  ING  - Ingestion
  LIC  - Licensing
  MTD  - Metadata
  MVN  - Maven
  NET  - Network
  REPL - Replication
  RT   - Runtime
  SITE - Website
  SQL  - Translator SQL++
  STO  - Storage
  TEST - Test Framework
  TX   - Transactions
  TYPE - Data Model
  UI   - Web Interface
Example
[ASTERIXDB-XXX][API] fix JSON output

- user model changes: fix for HTTP API result
- storage format changes: no
- interface changes: no

details:
- Add the bracket brace that was missing when writing arrays that are nested
  more than 5 levels deep.

 

 

  • No labels