Development Process

The Adapto Project uses a typical distributed development process.

First, join the Sourceforge Adapto-project developers mailing list. Second, get a free GitHub user id if you don't already have one. Once you have a GitHub user id, you can contribute to the Adapto Wiki on GitHub.

To contribute code to Adapto, fork the main egeniq/adapto project to your own account. If you're actively working on something, please send a note to the mailing list so the community is aware and everyone can benefit. Successful open source projects are collaborative, and depend on everyone staying informed.

Development Steps

1. Login to GitHub and fork the master Adapto project to your own GitHub account.

To fork the master Adapto project, access the egeniq/adapto project, and click the Fork button at the top of the page (just below your login name). Forking is similar to cloning, except forks can use GitHub's unique Pull-Request feature to submit changes back to the core project team.

2. Clone your Adapto fork to your development system.

How you do this will depend on the protocol you want to use and on your development environment. The git protocol uses ssh keys instead of passwords, but uses a non-standard port and is generally blocked by corporate firewalls. The https protocol generally works behind corporate firewalls (unfortunately not mine though), but requires typing your GitHub login name and password each time you commit (although they can be temporarily cached). Which protocol you use is determined by the format of the source URL in the clone command.

On Windows, I use the Git-Extensions GUI together with Paegent (and PuTTYgen) for managing my ssh keys

3. Make changes in your local adapto working directory - fix a bug, add a feature, or just correct a spelling mistake, it's all good.

This includes testing!

4. Commit your changes to your local Adapto git repo

Use git add/commit/commit -a to commit your changes locally

5. Push your local changes to your GitHub fork (in your own GitHub account).

First, fetch any changes that were committed recently to the master Adapto since you cloned locally, then use "$ git push origin master" to push your local changes to the repo in your GitHub account.

6. Send the core team a pull request for your changes

Click the Pull Request button at the top of your Adapto fork (in your GitHub account).

7. Keep an eye on the pull request as Ivo may comment on your code there.

8. Once your pull is approved, Ivo will merge it into the master codebase.