Skip to content
This repository has been archived by the owner on Sep 25, 2018. It is now read-only.

Latest commit

 

History

History
82 lines (56 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

82 lines (56 loc) · 2.64 KB

Contributing to BOTK-context

Contributions to geocodingit are always welcome. You make our lives easier by sending us your contributions through pull requests.

Pull requests for bug fixes must be based on the current stable branch whereas pull requests for new features must be based on master.

Due to time constraints, we are not always able to respond as quickly as we would like. Please do not take delays personal and feel free to remind us here, on IRC, or on Gitter if you feel that we forgot to respond.

Set-up of a local workstation

Before begin be sure to have:

  • a virus free workstation with a fresh OS (windows, MAC, Linux)
  • at least 512K Ram required to run the whole integration testing environment
  • a processor with virtualization support
  • an editor of your choice able read unix-style line endings docs (i.e. notepad++)

Local workstation installation process:

  • install GIT. Select “checkout as is , commit Unix-style line endingsâ€�. If your workstation is windows based and you to want to use pageant for authentication, in windows use putty plint interface as ssh proxy or reconfigure GIT to use ssh tool if needed.
  • install Vagrant
  • install Virtualbox

You are free to optionally install your preferred language ide (aptana, eclipse, other)

Using BOTK-context from a git checkout

The following commands can be used to perform the initial checkout from a bash shell:

git clone https://github.com/linkeddatacenter/BOTK-context.git
cd BOTK-context

Developing code and unit tests

Vagrant and virtualbox will setup a complete integration test environment.

To create and login into integrate testing environment, just type:

vagrant up
vagrant ssh

Note that on first execution the install script will ask for LinkedData.Center endpoint and credentials to use. The APIs will be available at http://localhost:8080/

All BOTK-context code is shared in /opt/BOTK-context inside virtual host.

Retrieve BOTK-context's dependencies using Composer:

cd /opt/BOTK-context
composer update

Unit tests are performed through PHPUnit. To launch unit tests:

phpunit --coverage-html test/unit/report

Free testenv resources with:

vagrant destroy --force

Sending your code to us

Standards

We are trying to follow the PHP-FIG's standards, so when you send us a pull request, be sure you are following them.

Please see http://help.github.com/pull-requests/.