zcy
/
svgedit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
svgedit/docs/Contributing.md

20 lines
615 B
Markdown
Raw Normal View History

LGTM.com-inspired changes: - Fix: Ensure all apostrophes are escaped for `toXml` utility - Fix: Avoid error if `URL` is not defined - Fix (jPicker): Precision argument had not been passed in previously - Fix (Star extension): Minor: Avoid erring if `inradius` is `NaN` - Refactoring: Avoid passing unused arguments, setting unused variables, and making unnecessary checks; avoid useless call to `createSVGMatrix` - Linting (LGTM): Add `lgtm.yml` file (still some remaining items flagged but hoping for in-code flagging) - Docs: Contributing file
2018-09-21 02:56:07 +00:00
# Contributing
- Update (Imagelib): Remove extra (and more outdated) jQuery copy - Refactoring (minor): Reuse local variable - Docs: Contributing re: updates
2018-09-25 06:21:40 +00:00
1. Prefix every change in the commit (and change log) with one of the
following types (and sort in both places into this order):
LGTM.com-inspired changes: - Fix: Ensure all apostrophes are escaped for `toXml` utility - Fix: Avoid error if `URL` is not defined - Fix (jPicker): Precision argument had not been passed in previously - Fix (Star extension): Minor: Avoid erring if `inradius` is `NaN` - Refactoring: Avoid passing unused arguments, setting unused variables, and making unnecessary checks; avoid useless call to `createSVGMatrix` - Linting (LGTM): Add `lgtm.yml` file (still some remaining items flagged but hoping for in-code flagging) - Docs: Contributing file
2018-09-21 02:56:07 +00:00
- `Security fix: `
- Docs (CHANGES) - Docs: Add "known regression" as possible commit prefix
2018-09-22 02:12:11 +00:00
- `Known regression: `
LGTM.com-inspired changes: - Fix: Ensure all apostrophes are escaped for `toXml` utility - Fix: Avoid error if `URL` is not defined - Fix (jPicker): Precision argument had not been passed in previously - Fix (Star extension): Minor: Avoid erring if `inradius` is `NaN` - Refactoring: Avoid passing unused arguments, setting unused variables, and making unnecessary checks; avoid useless call to `createSVGMatrix` - Linting (LGTM): Add `lgtm.yml` file (still some remaining items flagged but hoping for in-code flagging) - Docs: Contributing file
2018-09-21 02:56:07 +00:00
- `Breaking change: `
- Compatibility fix (openclipart): Ensure polyfill present; make separate non-modular build (still not integrated as API incomplete) - Docs: Add compatibility fix to Contributing
2018-09-26 08:06:57 +00:00
- `Compatibility fix: `
LGTM.com-inspired changes: - Fix: Ensure all apostrophes are escaped for `toXml` utility - Fix: Avoid error if `URL` is not defined - Fix (jPicker): Precision argument had not been passed in previously - Fix (Star extension): Minor: Avoid erring if `inradius` is `NaN` - Refactoring: Avoid passing unused arguments, setting unused variables, and making unnecessary checks; avoid useless call to `createSVGMatrix` - Linting (LGTM): Add `lgtm.yml` file (still some remaining items flagged but hoping for in-code flagging) - Docs: Contributing file
2018-09-21 02:56:07 +00:00
- `Fix: `
- `Fix (<component>): ` Component may be an extension, locale, etc.
- Imagelib backward compatibility enhancement: Allow string based API again so as not to break old SVG-Edit which fail at *presence* of `namespace` (fixes #274) - Known regression: Remove Openclipart as its site's now setting of `X-Frame-Options` to `"sameorigin"` makes it unusable on our end for our cross-origin uses - Forward compatibility enhancement: For IAN image library, add `svgedit=3` param to URL so that it can keep using old API for SVG-Edit versions before 3, while conditionally using new object-based API now (and if we switch exclusively to the object-based API in the future, this site will continue to work) - Docs: Add "Forward compatibility enhancement" to list
2018-09-25 02:13:29 +00:00
- `Forward compatibility enhancement: `
LGTM.com-inspired changes: - Fix: Ensure all apostrophes are escaped for `toXml` utility - Fix: Avoid error if `URL` is not defined - Fix (jPicker): Precision argument had not been passed in previously - Fix (Star extension): Minor: Avoid erring if `inradius` is `NaN` - Refactoring: Avoid passing unused arguments, setting unused variables, and making unnecessary checks; avoid useless call to `createSVGMatrix` - Linting (LGTM): Add `lgtm.yml` file (still some remaining items flagged but hoping for in-code flagging) - Docs: Contributing file
2018-09-21 02:56:07 +00:00
- `Enhancement: `
- `Refactoring: `
- `Linting (<type>):` - Linting by type, e.g., "ESLint"
- Fix: Avoid errors occurring in Chrome now for `supportsGoodTextCharPos` - Linting: Avoid Jamilih file in doc linting - Testing: Add testcafe (ESLint plugin/rules, accessibility test (failing), ui test beginnings (passing)) - Docs: Add "Testing" prefix to contributing file - npm: Bump to 3.0.0-rc.3
2018-09-30 04:05:50 +00:00
- `Testing:`
LGTM.com-inspired changes: - Fix: Ensure all apostrophes are escaped for `toXml` utility - Fix: Avoid error if `URL` is not defined - Fix (jPicker): Precision argument had not been passed in previously - Fix (Star extension): Minor: Avoid erring if `inradius` is `NaN` - Refactoring: Avoid passing unused arguments, setting unused variables, and making unnecessary checks; avoid useless call to `createSVGMatrix` - Linting (LGTM): Add `lgtm.yml` file (still some remaining items flagged but hoping for in-code flagging) - Docs: Contributing file
2018-09-21 02:56:07 +00:00
- `Docs: `
- `Update: ` - e.g., if updating a bundled library
- `Build: `
- `npm` - Updates to dependencies, npm version, etc.