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

Update contributing docs to account for new @embroider/macros based build setup #1274

Merged
merged 1 commit into from Oct 6, 2020

Conversation

simonihmig
Copy link
Contributor

Fixes #1124

Copy link
Contributor

@jelhan jelhan left a comment

Choose a reason for hiding this comment

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

Thanks a lot for working on this one!

I think the introduction should be changed as well. It says that the project structure is different to support multiple Bootstrap versions:

This addon supports Bootstrap 3 and 4 at the same time. Therefore the project structure is a bit different than that of usual Ember addon. Please read the section on Dual Bootstrap support for more detailed explanations.

I think "project structure" does not fit well for our new approach. For me it sounds like file system layout.

Not sure if want to speak directly about "build-time macros" or Embroider. Maybe "feature flags" is a more common term? I think what we are doing here is supporting Bootstrap 3 and 4 through build-time feature flags.

From that perspective using Embroider macros or a special file system layout is an implementation detail only.

CONTRIBUTING.md Outdated Show resolved Hide resolved
@simonihmig
Copy link
Contributor Author

I think the introduction should be changed as well. It says that the project structure is different to support multiple Bootstrap versions:

I changed it to "build setup" if you don't mind. Feature flags seems a bit misleading for me, as I think of it as a flag to enable some kind of experimental feature, which is disabled by default. At least that's how they are used for Ember canary.

@simonihmig simonihmig merged commit 09533ee into master Oct 6, 2020
@simonihmig simonihmig deleted the contrib-docs branch October 6, 2020 21:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Dual bootstrap support chapter in contributing docs is outdated
2 participants