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

25 lines
855 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: `
- Deprecated: Should now use `avoidClientSideDownload` in place of `avoidClientSide` (config for `ext-server_opensave.js`). - Enhancement: Added `avoidClientSideOpen` config for `ext-server_opensave.js` - npm: Update devDeps (including switching from deprecate opn-cli package to open-cli)
2019-05-21 09:50:17 +00:00
- `Deprecated:`
- 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: `
- Docs: Add CHANGES info for npm 3.0.0-alpha.1 (i.e., changes between 2.8.1 and alpha.2) - Docs: Add "optimization" and "localization" as commit prefixes
2018-10-22 02:58:39 +00:00
- `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: `
- Docs: Add CHANGES info for npm 3.0.0-alpha.1 (i.e., changes between 2.8.1 and alpha.2) - Docs: Add "optimization" and "localization" as commit prefixes
2018-10-22 02:58:39 +00:00
- `Optimization: ` - Performance enhancements
- `Localization:`
- Refactoring: Move `build-html` to `build` directory - Optimization: Remove old build/tools closure/yuicompressor code - Testing: Produce mochawesome report - Testing: Cypress with multiple reporters (was expecting we'd need, but doesn't hurt to add for now) - Docs: Add testing badge - Docs: Reprioritize `docs` in commit lists (prioritize user-facing) - npm: Update `package-lock.json` (seems to have fixed so Cypress shows incremental results)
2019-12-21 07:35:19 +00:00
- `Docs: `
- Docs: Contributing
2018-10-01 06:59:43 +00:00
- `Update: ` - e.g., if updating a bundled library or updating code per a
dependency's updated new API
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
- `Refactoring: `
- `Linting (<type>):` - Linting by type, e.g., "ESLint"
- Linting: Lint hidden `ncurc.js` file - Docs: Add 6.0.0.md migration file - Docs: Update Contributing, Testing (renamed to Development), Linting and ReleaseInstructions - Docs: Info on submodules - npm: Add scripts for updating submodules - npm: Add `license-badges`, `build-docs`, and `copy` scripts to `prepublishOnly` script - npm: Bump to 6.0.0
2020-02-22 03:38:33 +00:00
- `Testing (<UI|Unit>):`
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
- `Build: `
- `npm` - Updates to dependencies, npm version, etc.
- Docs: Update testing info; update CHANGES - `editorconfig`: Use 4 spaces for Markdown - npm: Rename and group various development scripts
2020-02-20 04:31:06 +00:00
1. See [`Testing.md`](./Testing.md) for other information helpful for contributing.