59 lines
2.6 KiB
Markdown
59 lines
2.6 KiB
Markdown
* **Please check if the pull request fulfills these requirements**
|
|
- [ ] Tests for the changes have been added (for bug fixes / features)
|
|
- [ ] Does it pass all existing unit tests without modification?
|
|
- If not, what did you change?
|
|
- If you altered it significantly, what coverage issue did you fix?
|
|
- [ ] Docs have been added / updated (for bug fixes / features)
|
|
- [ ] CHANGELOG.md has been updated to describe this change
|
|
|
|
<!-- Please also consider adding yourself to CONTRIBUTORS.md as part of your pull request. We'd like to recognise you for your efforts! -->
|
|
|
|
<!-- To update the documentation on yarnspinner.dev, please submit a pull request to the documentation repository at https://github.com/YarnSpinnerTool/Docs. -->
|
|
|
|
* **What kind of change does this pull request introduce?**
|
|
|
|
- [ ] Bug Fix
|
|
- [ ] Feature
|
|
- [ ] Something else
|
|
|
|
* **What is the current behavior?**
|
|
|
|
<!-- If you are fixing a known bug, you can also link to an open issue here. -->
|
|
|
|
* **What is the new behavior (if this is a feature change)?**
|
|
|
|
<!-- Please describe, in as much detail as you can, what your pull request changes in Yarn Spinner. -->
|
|
|
|
* **Does this pull request introduce a breaking change?**
|
|
|
|
<!-- What changes might users need to make in their application due to this PR? -->
|
|
|
|
* **Other information**:
|
|
|
|
<!--
|
|
|
|
Ideas:
|
|
|
|
- Performance?
|
|
- Does this drastically change performance characteristics, or simply allow for optimizations?
|
|
- Does this performance involve:
|
|
- Disk access
|
|
- CPU time
|
|
- Memory layout optimization (Lx caching etc)
|
|
- Might there be a use case where you are encouraged to be unperformant by default?
|
|
- What optimizations did you consider but left out due to time and/or complexity?
|
|
- Usability?
|
|
- If your change is to a sample, is it accessible? We don't follow standards like WCAG but any easy wins should be taken.
|
|
- Does it make it easier to use our API? If not, what annoyance mitigations have you taken/considered?
|
|
- Who will be affected?
|
|
- Is this an internal change, or something meant to be consumed by the end user?
|
|
- If you add API changes, is it easily upgradable from the previous version?
|
|
- What indirect consequence might be annoying to the end user?
|
|
- For what reasons would you say this is justified? E.g. super annoying to use in the first place, tightening up undefined behavior etc.
|
|
- What do you think will be controversial, if any?
|
|
- How would you describe the cause of the problem and changes to non-technical users if at all possible?
|
|
|
|
Feel free to take any all or none of these points as relevant, though we recommend you read through each point. They're just to get you started!
|
|
|
|
-->
|