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

docs: add initial Dart style guide #1967

Merged
merged 5 commits into from
Apr 25, 2024
Merged

docs: add initial Dart style guide #1967

merged 5 commits into from
Apr 25, 2024

Conversation

bryanoltman
Copy link
Contributor

Description

Adds the start of a Dart style guide.

Type of Change

  • ✨ New feature (non-breaking change which adds functionality)
  • 🛠️ Bug fix (non-breaking change which fixes an issue)
  • ❌ Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 Code refactor
  • ✅ Build configuration change
  • 📝 Documentation
  • 🗑️ Chore

style_guides/dart.md Outdated Show resolved Hide resolved
style_guides/dart.md Outdated Show resolved Hide resolved
style_guides/dart.md Outdated Show resolved Hide resolved
This guide is a supplement to
[Effective Dart](https://dart.dev/guides/language/effective-dart) and should be
read in the same way. If there is a conflict between this guide and Effective
Dart, this guide takes precedence.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Dart, this guide takes precedence.
Dart, this guide takes precedence.
*Note: This style guide only defines rules which are enforced via lint rules.*

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Which are NOT enforced by lint rules, you mean?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated to say:

This style guide only defines rules which are not enforced via lint rules. If possible, prefer using lint rules to enforce style.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yup sorry I was clearly tired when I reviewed 😴

style_guides/dart.md Outdated Show resolved Hide resolved
style_guides/dart.md Outdated Show resolved Hide resolved
bryanoltman and others added 3 commits April 25, 2024 09:34
Co-authored-by: Felix Angelov <felix@shorebird.dev>
Co-authored-by: Felix Angelov <felix@shorebird.dev>
@bryanoltman bryanoltman merged commit 8233339 into main Apr 25, 2024
7 checks passed
@bryanoltman bryanoltman deleted the bo/style-guides branch April 25, 2024 13:40
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.

None yet

2 participants