STYLE-GUIDE.md

Clone Tools
  • last updated a few seconds ago
Constraints
Constraints: committers
 
Constraints: files
Constraints: dates
Add HTTP caching and DTOs to style guide

Cross reference to performance docs. If HTTP caching is being implemented, need to check and potentially fix DTOs.

add note about audit log requirement

This has been a gap in documenting our non-functional requirement around audit logging.

some fixes to java conventions

Remove link to community princples doc

It'll be in RTD

add restful representation terms and details to style

Update style guide: UUIDs should end in "Id"

OLMIS-832 Update based on review feedback

Wordsmithing.

OLMIS-832 Add info about Transifex and the build

Add info about what happens in Transifex when the message source is modified.

OLMIS-1605: Update style guide

OLMIS-1605: Add audit log support

This commit introduces support for basic audit logging. In order to show this feature, it associates WidgetRepository with JaVers so that changes persisted to Widgets are logged. It also adds an endpoint at /api/widgets/{id}/auditLog to retrieve a list of these changes.

  1. … 10 more files in changeset.
Minor update to the styleguide

Tweak the pagination section.

OLMIS-1512, add pagination to styleguide

OLMIS-1560 Document high level guide on writing schema migrations

Also linked from style guide.

  1. … 1 more file in changeset.
Update style guide: UUID columns should end in id

moved right naming convention to it's own section

Update style guide with guidelines for right names

Establish a standardized pattern for right names.

change i18n guidelines to ban hyphens

* change i18n guidelines to ban hyphens

and use camelCase out of dev forum discussion.

* add explict ban of hyphens and other puncutation

* add highlight of keys

From dev forum discussion: https://groups.google.com/forum/#!topic/openlmis-dev/Z-e1J39QOm8

OLMIS-1069, add basic logging conventions

Filling in more of the logging conventions that came out of a discussion on error handling.

Fixed line breaks in links so they are interpreted by ReadTheDocs.

OLMIS-1162 Update style guide to talk about JSON value responses

We should enforce consistency in returning JSON values in endpoints by recommending they are wrapped in a JSON object. This is to be compliant with all JSON parsers.

OLMIS-894 Update style guide

Add entry about JSON schemas for RAML be put in separate JSON files.

Update style guide after review comments

Clarify no DTOs even for relationships in exporter/importer interfaces. Clarify resource as REST resource.

Update style guide with additional Java guidelines

* Add point about Importer/Exporter pattern

* Discourage use of no args constructor that Hibernate needs

* Design of domain objects vs. REST API resources

OLMIS-1083 Update style guide from review comments

Make things clearer about package naming.

OLMIS-1083 Update the style guide with new guidelines

Regarding generated filed, package naming and exceptions.

OLMIS-1079, fix anchor link on docker section

OLMIS-1079, moving docker best practices from wiki

Update STYLE-GUIDE.md

Fixed sub-headers display. All of them were marked as main headers

what would mess the dev docs.

Add info on updating a resource with PUT

PUT is not necessarily an update; add info to indicate that.

Also reformat some lines to wrap at 100 characters.

moved testing guide out

Removed testing guide content and linked to new testing guide file