How to modify an Atmosphere package with forking and symlink

package-symlink-instructions.md

Fork & Symlink an Atmosphere Package

If you want to submit a pull request for an Atmosphere package you will first need to

1. On GitHub fork the GitHub repository you want to make changes to.
2. Clone the repository to your local machine with the Terminal.

   • cd into the folder you want the repository saved in and run the git clone command.

   • If you do not know the git clone command we break it down into 3 parts.

   • First part of command is the git clone.

   • Second part, specify the clone link of your forked repository.

   • Third part, name the folder you want to be created and files saved into.

   • Below is an example of the full command

     $ git clone https://github.com/benstr/momentum-iron-router.git benstr-momentum-iron
     

3. Open the package in a code editor and make the changes/fixes you want.
4. Open a Meteor application that you can use to test your package changes on.
5. Symlink the modified package into the Meteor application.

   • In your Meteor app create a packages folder in the root of your app.

   • cd into the packages folder.

   • Run the symlink command $ ln -s **location of cloned package** ., below is an example. Make sure the location is absolute from the root not relative to the Meteor app.

     ln -s /Users/ben/code/packages/benstr-momentum-iron .
     

   • In the command line pretend to add the package as you normally would if you were grabbing it from Atmosphere. $ meteor add momentum-iron-router

   • Meteor will be smart enough to pull form your packages folder instead of the web.

6. Verify that your changes work.
7. If they do not work, any changes you make to the package directory will automatically be reflected in your app. So work at it until it is fixed!
8. Once all the desired changes are made you can git submit the modified package to your forked repository.
9. On GitHub find the button called Submit Pull Request, click it and follow any prompts.
10. You can now continue to use your modified package until the original package owner merges your changes, at which point you should revert back to using their package.