Getting involved in OpenSC development - xhanulik/OpenSC GitHub Wiki

Getting involved in OpenSC development

Contributions to OpenSC are welcome! This page explains how to contribute to OpenSC.

Development process

  • OpenSC development is coordinated via the list [email protected]. See Mailing lists. Start helping the community by reviewing GitHub issues . Patches fixing new or existing issues may be submitted as GitHub Pull Requests.
  • Contribution should comply with coding guidelines. A minimal Development Policy exists.
  • How to add/support a new card
  • New features need to be tested. At worst transcript of pkcs11-tool --test with your card should be attached to Pull Requests. Even better would be implementation of unit tests systematically testing introduced code.

Test Tools

GitHub process

GitHub is a web-based hosting service for software development projects using the Git revision control system.

git clone git://github.com/OpenSC/OpenSC.git
cd OpenSC
./bootstrap
  • Read latest commits.
  • To start coding, create a GitHub account. Creating an account with one project is free. Upload your public ssh keys.
  • Visit OpenSC Github project and click on Fork to create your own OpenSC repository. Majors features should have their own branch. Bug fixes should go to the Staging branch.
  • To propose a commit, make a pull request to the main OpenSC master repository.
  • Advertise your pull request. Pull requests are discussed and applied by github core developers.

Pull Requests

The github pull requests (PR) to OpenSC/OpenSC are/can-be checked automatically for building on Ubuntu Windows and OSX. At the moment this feature is installed to help the contributors to reveal the compilation errors on the platforms that they do not used to manage (mostly Windows).

The Travis CI runs basic tests on few emulated cards (PIV, IsoApplet, OpenPGP, GIDS, OsEID) to make sure your changes did not break basic functionality of them. Adding more tests is always welcomed.

The Team

Current developers/maintainers with recent activity in Github, in alphabetical order:

Developers/maintainers with established GIT write access can be found in OpenSC organization page.

The Emeritus of the OpenSC developer team as well as project chronology is listed on History-of-the-OpenSC-Project. List of all people who have sent patches to OpenSC is available on Github|https://github.com/OpenSC/OpenSC/graphs/contributors.

All links