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

Document how to contribute to Layerform #64

Open
5 tasks
lucasfcosta opened this issue Sep 7, 2023 · 0 comments
Open
5 tasks

Document how to contribute to Layerform #64

lucasfcosta opened this issue Sep 7, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@lucasfcosta
Copy link
Member

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)
@lucasfcosta lucasfcosta added documentation Improvements or additions to documentation good first issue Good for newcomers labels Sep 7, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@lucasfcosta