k2informaticsgmbh / development_guidelines

Development guidelines for the open source projects of K2 Informatics GmbH.

Development Guidelines

Development guidelines for the open source projects of K2 Informatics GmbH.

Why have standards?

• Better code
• Clearer understanding
• Easier maintenance
• Easier to use
• Fewer decisions to make

1. Building

     TBD

2. Coding

  In general

• Adopt a consistent format that is easy to read and maintain.
• Adopt consistent naming conventions.
• Comment tersely with value-added information.
• Don't worry about getting to 100% test coverage - 99% will do.
• Follow the test-driven development methodology.
• Test your programs thoroughly, and as automatically as possible.
• Use source code debuggers to hunt down the cause of bugs.

  PL/SQL

    Coding Style

    Coding Templates

    Error Handling

    Naming Conventions

    Unit Testing

3. Continuous Integration

  Travis CI

     TBD

4. Version Control

  Git

     TBD

  GitHub

    Badges

Appendix: References

• Coding Standards for SQL and PL/SQL

• Steven Feuerstein, Oracle PL/SQL Best Practises, O'Reilly & Associates, 2001

• PL/SQL Naming Conventions and Coding Standards (Oracle Developrer Community)

• Variables Best Practices - Naming Conventions (Toad world - Oracle Community