Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup readme and dev contributions #23

Merged
merged 3 commits into from
Aug 22, 2024
Merged

Conversation

ryanhristovski
Copy link
Member

auto-generating the ~/.terraformrc may be a bit overkill, fine removing this and describing how to in the doc

  • Setup a simple developer contribution guideline
  • Updated the readme

@ryanhristovski ryanhristovski requested a review from a team as a code owner August 21, 2024 20:54
@etugarinova
Copy link
Collaborator

Wouldn't you want to have the local development setup higher up? Or I'd say even in the read me because it's necessary in order to get started?

README.md Outdated Show resolved Hide resolved
Copy link

@cybercyst cybercyst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work here! The makefile target to generate your .terraformrc may be a bit much, but if it works for someone it would help them get bootstrapped faster!

@ryanhristovski
Copy link
Member Author

@etugarinova

Wouldn't you want to have the local development setup higher up? Or I'd say even in the read me because it's necessary in order to get started?

We can move it further up the doc, typically local setup is within the contributions doc from my experience. It's only necessary to develop, a majority of people who will view this repo will likely be looking more for usage than developing it I think.

Open to more discussion on this though, I cross referenced a couple of other OSS TF Providers (GCP, Github, Docker engine, etc..)

@etugarinova
Copy link
Collaborator

@ryanhristovski yeah maybe let's move it higher up. Maybe under "making code contributions" section?

@ryanhristovski ryanhristovski merged commit 247eec9 into main Aug 22, 2024
3 checks passed
@ryanhristovski ryanhristovski deleted the contributions-and-readme branch August 22, 2024 14:48
@nicks nicks mentioned this pull request Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants