cloudfoundry / cc-api-v3-style-guide

Style Guide for Cloud Controller v3 API
Apache License 2.0
21 stars 8 forks source link

Style guide doesn't include v3 commandments #1

Closed utako closed 9 years ago

utako commented 9 years ago

This was in an email after a v3 meeting a few months ago. We should maybe go over their relevance now, but I'd definitely like to see mention of how we use fetchers (e.g. DropletListFetcher), actions (e.g. AppUpdate), and stub out controller tests.

They are as follows:

• Fetchers return concrete things • Fetcher returns array of concrete things • Fetchers are specific to an operation • Transactions are in actions by default • There should be a message object responsible for basic validation on requests • Controller tests should not touch the database • During handler -> action transition, do not lose logic from access classes • If your actions don't have loggers, you broke them

cf-gitbot commented 9 years ago

We have created an issue in Pivotal Tracker to manage this. You can view the current status of your issue at: https://www.pivotaltracker.com/story/show/100477790.

zrob commented 9 years ago

Yeah, an implementation style guide may be useful as a separate doc. This style guide is sort of independent of the underlying implementation