Skip to content

Contribution

Paweł Hofman edited this page Jun 4, 2015 · 5 revisions

#Code Contribution There is only one requirement involved in participation in this code. Since I am continuously pushing parts of this code to master repository, you will need to sign some documents first to become the BlackBerry's open-source contributor and appear on the list of approved signatories. After that I won't make any problems accepting the changes, unless I find something in source-code of the pull-request.

Anyway, I am open to hear any improvements you would like to see in this plugin. Make sure to put them on that list.

#Adding a feature

  1. Fork the vs-plugin repository.
  2. Make the changes/additions inside your fork.
  3. Send a pull request from your fork back to the vs-plugin repository.
  4. I will review your code and merge. Please try to follow the standard C# coding conventions to keep this proces smooth.

#Branching This project contains the following code branches:

  • master - obsolete, used to merge with master BlackBerry-owned repository
  • next - obsolete, used to merge with next BlackBerry-owned repository
  • develop - main development branch, it's also the source of all public releases

#Build requirements

Currently Visual Studio 2010/2012/2013 are supported. Main development is performed under Visual Studio 2012 and so there are all the source files kept. You might also need to install following SDKs:

#Building You can always build it by opening BlackBerry.NativePlugin.sln solution for specific Visual Studio version and rebuild the BlackBerry.Package project. It will always produce valid VSIX package, ready to be installed and distributed.

To test a feature during development simply reference respective devenv.exe as [Start external program] on [Debug] tab of the project's properties and specify alternative registry root in [Command line arguments], not to interfere with your current Visual Studio instance you do the development (/rootSuffix Exp).

Project Config

#Build commands There is also a set of command-line commands to simplify automatic builds:

build.bat – A batch file that builds the various components of the BlackBerry Native Plug-in for Microsoft Visual Studio to the "_BuildResults" folder.

setup.bat – A batch file that installs the newly built components of the BlackBerry Native Plug-in for Microsoft Visual Studio to the correct locations on your computer.

Examples:

build.bat - default, builds everything
build.bat vs2010 - builds only for Microsoft Visual Studio 2010
build.bat vs2012 "/out:D:\Shared folder\_BuildResults" - builds only for Microsoft Visual Studio 2012 into the specified directory

setup.bat - installs the plug-in for all Microsoft Visual Studio versions
setup.bat vs2010 - installs the plug-in for only Microsoft Visual Studio 2010
setup.bat vs2012 /no-tools - installs the plug-in for Microsoft Visual Studio 2012 without copying the bbndk_vs and qnxtools folders
setup.bat vs2012 /msbuild-only - updates only the local MSBuild for Microsoft Visual Studio 2012 and adds the 'BlackBerry' and 'BlackBerrySimulator' target platforms

#Reference material

Clone this wiki locally