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

Syntax Compatibility Strategy document #251

Merged
merged 4 commits into from Apr 17, 2019

Conversation

stasm
Copy link
Contributor

@stasm stasm commented Apr 8, 2019

This document is based on my conversations with @flodolo and @Pike. The goal is to document the compatibility strategy for introducing and removing syntax features.

@stasm stasm requested review from flodolo and Pike April 8, 2019 10:59
Copy link
Contributor

@flodolo flodolo left a comment

Choose a reason for hiding this comment

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

A couple of questions, but in general it looks good to me.

spec/compatibility.md Outdated Show resolved Hide resolved
spec/compatibility.md Outdated Show resolved Hide resolved
spec/compatibility.md Outdated Show resolved Hide resolved
spec/compatibility.md Outdated Show resolved Hide resolved
spec/compatibility.md Outdated Show resolved Hide resolved
spec/compatibility.md Outdated Show resolved Hide resolved
spec/compatibility.md Outdated Show resolved Hide resolved
spec/compatibility.md Outdated Show resolved Hide resolved
Copy link
Contributor

@Pike Pike left a comment

Choose a reason for hiding this comment

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

Thanks for the update.

I have one more general thought, but not pressing right now: Should we be explicit about not allowing insta-break changes? I can see people wondering "Dude, I can also just break stuff, what's then?", might be good to make that explicit?

The only other thing I found was that it'd be nice to backport the changes you made to post 1.x at the bottom to the introduction part. I took a stab at that, feel free to put something else in there. Nothing blocking.

spec/compatibility.md Outdated Show resolved Hide resolved
Fluent implementation in the target project. Syntax newer than the upper bound
must not be allowed in the project's translations; syntax deprecated in
versions older than the lower bound should be reported as warnings, and later
on, as errors—depending on the grace period chosen for the project.
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for the em dash here. I could go with spaces around it, but I know that's debated spelling.

@stasm
Copy link
Contributor Author

stasm commented Apr 17, 2019

Thanks for the review, @Pike.

I have one more general thought, but not pressing right now: Should we be explicit about not allowing insta-break changes? I can see people wondering "Dude, I can also just break stuff, what's then?", might be good to make that explicit?

Let's work on adding this in a follow-up. Adding it won't contradict the overall tone of the document.

@stasm stasm merged commit dc373ec into projectfluent:master Apr 17, 2019
@stasm stasm deleted the compat-strategy branch April 17, 2019 06:58
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

3 participants