radius-project / radius

Radius is a cloud-native, portable application platform that makes app development easier for teams building cloud-native apps.
https://radapp.io
Apache License 2.0
1.43k stars 87 forks source link

Standardization of Radius #6287

Open ytimocin opened 1 year ago

ytimocin commented 1 year ago

Overview of the feature request

As Radius continues to grow and approaches the Public Preview phase, it becomes increasingly important to establish a standardized approach throughout its development lifecycle. This GitHub issue serves as a central point for discussing and implementing various aspects of standardization, ensuring consistent practices, and enhancing overall maintainability. It is especially crucial as we collaborate with external partners.

This issue is currently in draft mode and open for contributions and modifications from anyone.

Goal

The goal of this initiative is to achieve a higher level of consistency and best practices within Radius.

Proposed Tasks

Please feel free to add any tasks you see necessary.

Acceptance criteria

After the team determines that the sub-tasks are well-defined and aligned with the goal of standardization, the completion of all the sub-tasks can be considered as the acceptance criteria for this issue. This ensures that all the necessary steps have been taken to achieve the desired level of consistency and best practices within the Radius project.

Additional context

AB#11422

rynowak commented 8 months ago

This seems like a good idea but needs to get down to specifics before we can take any action 😁

I'd also like to mention that there's intentionally a high bar for new code-style rules. We want to keep our codebase friendly to new contributors, so the fewer rules we require the better. We always want to find a balance between keeping the code high quality and make it approachable for new people.

For example, for any new code-style rules, I really want to understand how they are going to make use more productive.

radius-triage-bot[bot] commented 4 months ago

:+1: We've reviewed this issue and have agreed to add it to our backlog. Please subscribe to this issue for notifications, we'll provide updates when we pick it up.

We also welcome community contributions! If you would like to pick this item up sooner and submit a pull request, please visit our contribution guidelines and assign this to yourself by commenting "/assign" on this issue.

For more information on our triage process please visit our triage overview

sylvainsf commented 3 months ago

@ytimocin can you please edit the main body to clarify the two proposed areas with specifics about the anti patterns that need to be fixed? Let's also update the issue title to be more specific.

radius-triage-bot[bot] commented 3 months ago

:+1: We've reviewed this issue and have agreed to add it to our backlog. Please subscribe to this issue for notifications, we'll provide updates when we pick it up.

We also welcome community contributions! If you would like to pick this item up sooner and submit a pull request, please visit our contribution guidelines and assign this to yourself by commenting "/assign" on this issue.

For more information on our triage process please visit our triage overview