Conventions for collaboration

[memes]

Thinking ahead as I get ready to contribute and the questions I have after reading Contributing doc and the community beyond just F5 that hopefully evolves from this effort. Requesting review by @piyerf5 @sstarzh @JeffGiroux @jmcalalang, @mjmenger.

As a collaborator, I want to understand the conventions and workflow for contributing to this project as it grows.

Coding style

• Should we have any style guidelines for Terraform and Terragrunt? Is an enforced terraform fmt sufficient?
• Should we reuse the existing Terraform and Terragrunt guides?
• Do we refactor existing work which diverges from guidelines? E.g. camelCase where snake_case is recommended.

Development

• Prefer (require?) commit messages to confirm to a standard, say Conventional Commits?
  • Pros: tooling to support automatic CHANGELOG management, and semantic release management through GitHub Actions
  • Cons: new habit to establish, can seem petty
• Enforce squash and rebase PRs, or keep the history?

Community

• Contributors covenant or similar declaration?
• Declaration of (lack of) F5 support?
• Encourage F5 slack for Q&A or keep it all to GitHub issues?

---

What else am I missing?

[mjmenger]

Thank you very much for this @memes. I'll express my opinion surgically in the structure of your original comment.

Coding style

• Yes, we should have style guidelines. Preferably capitalizing on the work of others.
• Using the existing Terraform and Terragrunt guides is a good idea.
• Yes, we should refactor existing work to conform to the guidelines. We should not do that globally. Let's fix non-conforming code as we touch it for other reasons.

Development

• I like the Conventional Commit messages idea. Let's go ahead and share it as a suggested rather than a required approach.
• I don't feel strongly about squash and rebase. What are the pros and cons?

Community

• A contributor's code of conduct is a critical addition to this project.
• Clarity about support is important. There are markdown files that we can copy that address this need.
• There are pros and cons to Slack + Issues v. Issues-alone. Let's discuss this further.

[mjmenger]

I created a branch for implementing solutions agreed upon in this thread.

git checkout 41-conventions-for-collaboration

Should I create a draft PR for the branch?

[mjmenger]

State management conventions. Remote? If so, where. Discuss...