Skip to content

contribution guide

Nickolas edited this page Mar 29, 2017 · 2 revisions

update package version

When you finish developing a package, update the npm version in package.json such as 0.1.1. Then tag it with the same version use github standard version description. eg. v0.1.1.
And then modify version in the main project's package.json, update git url in dependencies and npm version in packageDependencies.
At last, you can npm install && script/build --install to build a new package.
Packaging script will check update npm dependencies and install apm package, attach packages if there new version is found.

add a new package

There are two kind of package of atom, first is core package. Which is packaged to one asar file. Second is attach package, which is attach to link with thera after open thera the first time, each attach package uses separate npm dependencies. So we recommend using core package to minify package size.

as core package

Add package version to packageDependencies, and add package dependencies to dependencies. Or simply deploy to atom packages.

as attach package

Simply add package git url to attach-package in pakcage.json. Thera will get reset of it done.

code format

We use both coffee and javascript same as atom. We recommend you install and use linter-js-standard.

Clone this wiki locally