docs(faq): clarify the versioning strategy #15845
Conversation
- When do breaking changes appear - Relationship with Semver - Compatibility of modules
| { | ||
| "angular": "~1.6.0", | ||
| "angular-animate": "~1.6.0" | ||
| } |
There was a problem hiding this comment.
Maybe add another example where versions are really locked as well?
There was a problem hiding this comment.
You mean locked down to the patch version without ~?
There was a problem hiding this comment.
Yes, to indicate that if you lock to a specific version, all versions need to be the same.
docs/content/misc/faq.ngdoc
Outdated
| quickly before a release. We've had a pretty good experience with this setup. Only bugs that affect features | ||
| not used at Google or without sufficient test coverage, have a chance of making it through. | ||
| improvement, a considerable simplification of the code, a measurable performance improvement, or a better | ||
| developer experience (especially with regard to updating to Angular). |
docs/content/misc/faq.ngdoc
Outdated
| ("angular-animate", "angular-route" etc) that are dependant on the main module. | ||
| When a new AngularJS version is released, all modules are updated to the new version. | ||
| This means that the main module and the optional modules must always have the exact same version, | ||
| down the patch number, otherwise your application might break. |
docs/content/misc/faq.ngdoc
Outdated
|
|
||
| #### How does AngularJS ensure code quality and guard against regressions? | ||
|
|
||
| When adding new code to branches of AngularJS, have a very stringent commit policy: |
There was a problem hiding this comment.
Not sure what "branches" refers to 😁 Update: I get it now (after reading further below), but people won't know.
Also: have --> we have (?)
docs/content/misc/faq.ngdoc
Outdated
|
|
||
| When adding new code to branches of AngularJS, have a very stringent commit policy: | ||
|
|
||
| - Every commit must contain tests and documentation updates alongside the code changes and that all the |
docs/content/misc/faq.ngdoc
Outdated
| - Every commit must contain tests and documentation updates alongside the code changes and that all the | ||
| tests must pass; | ||
| - Commit messages must be written in a specific manner that allows us to parse them and extract the changes | ||
| for release notes. |
There was a problem hiding this comment.
Let's add a link to the commit message guidelines (or CONTRIBUTING.md).
| Additionally, commits are periodically synced to Google where we test it against applications using | ||
| the test suites of these applications. This allows us to catch regressions | ||
| quickly before a release. We've had a pretty good experience with this setup. Only bugs that affect features | ||
| not used at Google or without sufficient test coverage, have a chance of making it through. |
There was a problem hiding this comment.
I am not sure the last two paragraphs are super-relevant to external contributors.
There was a problem hiding this comment.
I assume they are meant to inspire confidence in the stability of AngularJS (I've just reworded them from their previous state)
There was a problem hiding this comment.
I didn't notice they were there before 😕 Fair enough.
👍 on rewording.
|
Updated, PTAL |
docs/content/misc/faq.ngdoc
Outdated
| #### How does AngularJS ensure code quality and guard against regressions? | ||
|
|
||
| When adding new code to branches of AngularJS, have a very stringent commit policy: | ||
| When adding new code to AngularJS, we have a very stringent commit policy: | ||
|
|
||
| - Every commit must contain tests and documentation updates alongside the code changes and that all the |
There was a problem hiding this comment.
and that all --> and all (or is it intentional?)
docs/content/misc/faq.ngdoc
Outdated
| @@ -130,8 +140,8 @@ Yes. See instructions in {@link downloading}. | |||
| ### What browsers does AngularJS work with? | |||
|
|
|||
| We run our extensive test suite against the following browsers: the latest versions of Chrome, | |||
| Firefox, Safari, and Safari for iOs, as well as Internet Explorer versions 9-11. See {@link guide/ie | |||
| Internet Explorer Compatibility} for more details on supporting legacy IE browsers. | |||
| Firefox, Safari, and Safari for iOs, Edge, as well as Internet Explorer versions 9-11. See | |||
There was a problem hiding this comment.
iOs --> iOS
(Are we running against Edge yet?)
There was a problem hiding this comment.
I removed it again. Edge had some problems with the script security checks last time i checked
|
Thanks for the reviews! |
- When do breaking changes appear - Relationship with Semver - Compatibility of modules Closes #15845
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Docs
What is the current behavior? (You can also link to an open issue here)
Information is not super clear
Please check if the PR fulfills these requirements
Other information:
clarify info on: