[Draft] Guides & best practices for application development at CoA
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples
services
README.md
READMEtemplate.md
github.md
index.md
local-environment.md
protected-branches.md
rebase.md
values.md
workflow.md
writing-a-commit.md

README.md

CoA Application Development Policies and Practices

Guides published at https://cityofaustin.github.io/ctm-dev-workflow/

This repo is a collaboration and publishing space for the CTM Application Development workflow. CoA software and web developers are encouraged to read the documentation and sign up for in-person training to learn how to incorporate the workflow into their daily work.

For now the guides will live here as markdown files but might evolve to be part of a broader documentation site, akin to 18F's Guides.

Support

The following support channels are available to help you:

  • Developer Training
    Fill out this form to request a training session at a time and location most convenient for you
  • Google Hangout Developer Help Desk
    Join this Hangout to speak directly to someone who can help. Someone should be on-hand most of the time to answer questions, though sometimes me
  • Slack #github channel1
    Join fellow CoA developers and GitHub users in Slack to ask questions or see if someone else is facing the same problem you are. It's helpful for other developers to see what issues you're encountering, becuase maybe they've dealt with them as well or will have to deal with them in the future.
  • Email
    Email Matt Langan with questions

Contributing

To contribute, follow the workflow prescribed in workflow.md. If you have questions or suggestions then create an Issue in this repository.

  1. Make sure you are a Member of the GitHub.com CoA organization and a Contributor on this repo

  2. Clone the repo

    $ git clone git@github.com:cityofaustin/ctm-dev-workflow.git
    

This repo just consists of markdown files, so no further setup guide is required. You can edit the static markdown files in your feature branch

The documents are written with a formatting syntax called markdown, which is used by sites like Reddit, Trello, and SiteLeaf to allow content writers to invoke HTML elements using basic text characters. GitHub and other hosting environments support a markdown superset called kramdown that allows for even greater utility. The kramdown Quick Reference Guide is a great starting point for familiarizing yourself with the syntax and its capabilities.

If you don't have a preferred markdown editor I recommend Typora.


1 If you don't have a Slack account then send an email to matt.langan@austintexas.gov to request one.