From 527210f72c206934283f12b4668dbbdda6f5b269 Mon Sep 17 00:00:00 2001 From: Tim van der Lippe Date: Sat, 24 Jun 2017 13:20:19 +0200 Subject: [PATCH] Add instructions for local development 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. --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f74c9b3ab..e6ee13d47 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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)