Skip to content
This repository was archived by the owner on Dec 26, 2023. It is now read-only.
This repository was archived by the owner on Dec 26, 2023. It is now read-only.

Document how to contribute to Layerform #64

@lucasfcosta

Description

@lucasfcosta

With new contributors coming in, we should write a proper CONTRIBUTING.md file to guide new developers and offer then a good experience.

Here are a few things I think we should include:

  • How to install the Layerform CLI locally
  • How to run the Layerform CLI straight from source go run main.go
  • What the examples do and how to run them
  • Brief guidelines on how the internals of the project work and where important files/functions are
  • Code standards (go fmt etc)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions