pulsar-edit/pulsar
1
1
Fork 0
mirror of https://github.com/pulsar-edit/pulsar.git synced 2024-09-11 11:15:24 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add instructions for local development

Browse Source 
Finding out how to contribute to my first Atom package was problematic
and took me quite some time to figure out how to locally run the packages.
There were some spread out answers in the Atom discussion forum,
but I think it is easier for new developers to read the CONTRIBUTING guide
instead of using Google to find out how to contribute.
This commit is contained in:
Tim van der Lippe 2017-06-24 13:20:19 +02:00 committed by GitHub
parent 5a8dce1175
commit 527210f72c
1 changed files with 13 additions and 0 deletions
Show Stats 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)