Contributing
Forcefield is developed on GitHub. We welcome pull requests and bugs filed there.
Getting set up
Apps Script is a bit tricky to integrate with source control, since scripts typically live in Google Drive and nowhere else. However, the Google Plugin for Eclipse allows syncing files in an Apps Script project on Drive with files on your local filesystem.
Of course, you can always work with your files using git like normal, but if you want to run your modified version of the script and test it out on Apps Script, here are the steps you’ll want to follow:
- Create a blank project in Apps Script and give it a name.
- Install Eclipse.
- Install the Google Plugin for Eclipse.
- Follow the instructions for using the Google Plugin for Eclipse with an Apps Script project.
- Clone the Forcefield repository, if you haven’t already done so.
- Go to the directory that Eclipse created for your blank Apps Script project, and create symlinks to each of the files in the Forcefield repository clone. (A quick way to do this is to run
ln -s /path/to/your/repo/script/* ./
from within the directory Eclipse created, making sure to specify thescript/
subdirectory inside wherever you cloned the repository.)
If you refresh your Eclipse project, you should see all the Forcefield files show up, and if you refresh your browser they should likewise show up in your previously-empty Apps Script project.
Now changes you make in Eclipse will get synced to the copy of your Apps Script project online as well as to your local clone of the Forcefield repository.
To get your new Apps Script project up and running, see the procedure outlined in setting up your own copy; you can skip the first few steps that mention how to create the Apps Script project.