Skip to content

Develop/contributor documentation? #29

@robdimsdale

Description

@robdimsdale

I don't see any documentation aimed at developers and contributors. Maybe I'm missing something that already exists, maybe it doesn't exist yet. Either way it would be helpful to link to it from the README.

What I'm looking to see is something like the following:

  • How can I validate that a deployment of concourse bosh-release runs fine against e.g. bosh-lite.
    • Are there are acceptance/end-to-end tests, perhaps against a bosh deployment?
    • How should I run tests against concourse submodules without running the tests against all the dependencies?
  • What is my development workflow?
    • What external, non-golang dependencies do I need to install and/or configure? For example I've already identified that ATC requires postgres and phantomjs
    • What (if any) githooks should I set up?
    • What scripts should I run before commiting
    • Should I run some/all tests in a docker container? I see various docker files, what are they all for?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions