github/atom
1
1
Fork 0
mirror of https://github.com/atom/atom.git synced 2026-01-24 22:38:20 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #14886 from TimvdLippe/patch-1

Browse Source 
Add instructions for local development
This commit is contained in:
Max Brunsfeld
2017-06-29 11:20:48 -07:00
committed by GitHub
parent fc3915e656 527210f72c
commit 5fc602a178
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md
View File

@@ -197,6 +197,19 @@ Both issue lists are sorted by total number of comments. While not perfect, numb
If you want to read about using Atom or developing packages in Atom, the [Atom Flight Manual](http://flight-manual.atom.io) is free and available online. You can find the source to the manual in [atom/flight-manual.atom.io](https://github.com/atom/flight-manual.atom.io).
#### Local development
All packages can be developed locally, by checking out the corresponding repository and registering the package to Atom with `apm`:
```
$ git clone url-to-git-repository
$ cd path-to-package/
$ apm link -d
$ atom -d .
```
By running Atom with the `-d` flag, you signal it to run with development packages installed. `apm link` makes sure that your local repository is loaded by Atom.
### Pull Requests
* Fill in [the required template](PULL_REQUEST_TEMPLATE.md)