Terraform AWS Provider Livery

[YakDriver]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

In Formula 1, "livery" is the paint and sponshorship logo scheme of a race car. In honor of the motorsport tradition of beautiful liveries showing off engineering masterpieces, I propose adding a new "livery" label.

Technical Debt vs. Livery

The technical debt and livery concepts may overlap a little, which is okay, but they have different emphases. Technical debt (aka code debt) emphasizes rework to improve engineering correctness. For example, technical debt includes engineers reworking code to adopt a new pattern that handles errors better. On the other hand, livery is not grounded in engineering or correctness per se but in perception--making things look better. For example, livery includes adopting styling and consistent formating in code and documentation. Technical debt is about being professional while livery is about looking stylish and professional.

Why Beauty?

To paraphrase the HashiCorp Principles:

Beauty... requires... consideration for the consumer of our work...

[M]aking something beautiful [shows] consideration of our peers, users, partners and customers... Making something beautiful requires more short term effort but increases the longevity and long-term efficiency.

In 2021, Apple continues to be the most admired company in the world. However, it would be impossible to separate that success from the extraordinary effort Apple puts into making things beautiful, from the shape and color of a MacBook Pro to the beautiful packaging it comes in. As a consumer, you feel like you've won a prize opening an Apple product because of the consideration they show you with beauty.

Ideas for Livery Improvements in the AWS Provider

GitHub Label Colors

The label colors should be functional, such as emphasizing urgency over information, but together the colors should look great together.

Code and Documentation Style Conventions

OSS brings together the best of a diverse community. However, that diversity should not lead to the code and documentation looking like a hodgepodge of styles. We should adopt the most respected conventions and strictly enforce them.

Documentation Grammar

Documentation should be clear, concise, and correct. Simple things like avoiding passive voice and keeping average sentence lengths down go a long way.

Commit Messages

Enforcing a standardized form for commit messages makes commit logs look professional. In addition, when going through debugging with Git blame, life is easier with good, consistent messages.

References

• https://www.hashicorp.com/our-principles

[github-actions]

Marking this issue as stale due to inactivity. This helps our maintainers find and focus on the active issues. If this issue receives no comments in the next 30 days it will automatically be closed. Maintainers can also remove the stale label.

If this issue was automatically closed and you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thank you!

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.