Respond to @psibi's comments
This commit is contained in:
parent
7a4b2812c1
commit
3247237c44
2
.github/ISSUE_TEMPLATE.md
vendored
2
.github/ISSUE_TEMPLATE.md
vendored
@ -25,5 +25,5 @@ command -v yesod && yesod version
|
|||||||
|
|
||||||
### Support
|
### Support
|
||||||
|
|
||||||
Please direct support questions to [Stack Overflow](https://stackoverflow.com/questions/tagged/yesod) or the [Yesod Google Group](https://groups.google.com/forum/#!forum/yesodweb). If you don't get a response there, or you suspect there may be a bug in Yesod causing your problem, you're welcome to ask here.
|
Please direct support questions to [Stack Overflow](https://stackoverflow.com/questions/tagged/yesod+haskell) or the [Yesod Google Group](https://groups.google.com/forum/#!forum/yesodweb). If you don't get a response there, or you suspect there may be a bug in Yesod causing your problem, you're welcome to ask here.
|
||||||
-->
|
-->
|
||||||
|
|||||||
@ -70,12 +70,13 @@ Examples are recommended, but not required, in documentation. Marking new APIs w
|
|||||||
|
|
||||||
### Versioning
|
### Versioning
|
||||||
|
|
||||||
Yesod packages roughly follow the Haskell Package Versioning Policy style of MAJOR.MAJOR.MINOR.PATCH
|
Yesod packages roughly follow the Haskell Package Versioning Policy style of A.B.C.[D] (MAJOR.MAJOR.MINOR.[PATCH])
|
||||||
|
|
||||||
* MAJOR - Used for massive changes in the library
|
* A - Used for massive changes in the library. (Example: 1.2.3.4 becomes 2.0.0)
|
||||||
* MAJOR - Used for smaller breaking changes, like removing, renaming, or changing behavior of existing public API.
|
* B - Used for smaller breaking changes, like removing, renaming, or changing behavior of existing public API. (Example: 1.2.3.4 becomes 1.3.0)
|
||||||
* MINOR - Used for new public APIs
|
* C - Used for new public APIs (Example: 1.2.3.4 becomes 1.2.4)
|
||||||
* PATCH - Used for bug fixes
|
* D - Used for bug fixes (Example: 1.2.3.4 becomes 1.2.3.5).
|
||||||
|
* D is optional in the version number, so 2.0.0 is a valid version.
|
||||||
|
|
||||||
Documentation changes don't require a new version.
|
Documentation changes don't require a new version.
|
||||||
|
|
||||||
@ -83,7 +84,7 @@ If you feel there is ambiguity to a change (e.g. fixing a bug in a function, whe
|
|||||||
|
|
||||||
Unlike in the Package Versioning Policy, deprecations are not counted as MAJOR changes.
|
Unlike in the Package Versioning Policy, deprecations are not counted as MAJOR changes.
|
||||||
|
|
||||||
In some cases, dropping compatibility with a major version of a dependency (e.g. changing from transformers >= 0.3 to transformers >= 0.4), is considered a MAJOR breaking change.
|
In some cases, dropping compatibility with a major version of a dependency (e.g. changing from transformers >= 0.3 to transformers >= 0.4), is considered a breaking change.
|
||||||
|
|
||||||
### Changelog
|
### Changelog
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user