Getting SP3 applications ready for pilot testing - round 1

From wiki.gpii
Jump to: navigation, search

There are 2 steps involved in getting your SP3 application ready for the pilots:

  • Getting your solution entry and needs and preferences sets to the main repository
  • Making your application available to the test sites

Getting your solution entry and needs and preferences sets to the main repository

Creating a GitHub account

The first thing you need to do is to make sure that you have a GitHub account. If you haven't one already, you can go to http://github.com and sign up for one.

Forking the main repository, downloading the code and updating it

Next step is to fork the main GPII (universal) repository. The repository you need to fork is: http://github.com/GPII/universal. The below link describes in step 1 how to fork the code, and in step 2 how to download the code to your local repository

https://help.github.com/articles/fork-a-repo

NB: Note that you now need to run: "npm install" inside the universal directory to download all dependencies.

From here on, you can do the changes to the code that you want;

  • Add your solution to the solution registry: testData/solutions/win32.json
  • Add two new NP sets added in: testData/preferences/ — eg. for maavis, you would create two different preferences sets named "maavis1.json" and "maavis2.json"

Once all your changes are done, you can review them (git status and git diff) and commit them with git add <filenames> and git commit -m "<description of changes>".


Each solution should also have acceptance tests.

Pushing your changes and issuing a pull request

The final step is to push your changes to your own GitHub repository and requesting them to be pulled into the main GPII repository (ie.g a pull request). That process is described in the below link.

https://help.github.com/articles/using-pull-requests

Note: There will usually be a JIRA ticket for the task of integrating your solution. Please cite this JIRA ticket when you make a pull request on GitHub.

Making your application available to the test sites

  • We're still examining what the best way to do this - check back for an update on it.
  • So far, most SP3 implementers have provided download links to their solutions.