Skip to content

Latest commit

 

History

History
83 lines (53 loc) · 3.14 KB

IDEAS.md

File metadata and controls

83 lines (53 loc) · 3.14 KB
Raw

Ideas for Contributing to Elektra

This page is the first point for anyone interested in contributing to Elektra!

GSoC 2019

This page is also the central point for students interested in contributing to Elektra during Google Summer of Code 2019.

Google Summer of Code is a opportunity for you to get paid while working on free software initiatives during summer:

Disclaimer: We do not yet know if we will participate!

Which GSoC projects are available?

We think that GSoC is a perfect opportunity to bridge Elektra and other free software projects. So the ideal GSoC project is to elektrify some free software. (“Elektrify” means that other software is patched to use Elektra instead of their own configuration system and includes the task of writing a specification on what the configuration of the application looks like.)

Elektra may be used for applications (frameworks) like KDE, GNOME, and LXCE or for any applications that need to read configuration files, access environment variables, or command-line parameters.

So you can simply suggest which project/framework/... you want to elektrify. We especially encourage to select projects, which are not by themselves part of GSoC.

What are the requirements to participate?

  • At least one PR submitted to Elektra (see below for details).
  • Fluent in English or German
  • Good writing skills in English
  • Profound programming skills with focus on good code quality, documentation and unit tests.
  • Ideally experience with an application (framework) or even author of a FLOSS application

How can I get started?

We prepared good first issues for you.

  • We encourage you to improve documentation.
  • In the source code, you should look into libs and plugins.
  • You can always peek into the TODOs, if you don't know what to do.
  • An ideal project is to elektrify some free software.

Elektrify means:

  • Patch the application so that it uses Elektra as its configuration system.
  • Write a specification that describes how the configuration of the application looks like.

If you are interested in directly improving Elektra, other projects might be of more interest to you:

  • Further configuration file formats could be supported.
  • The qt-gui could be improved.
  • Your own ideas?

What are the requirements to participate?

Anyone can join!

First you should familiarize with the Elektra Initiative:

  • If you did not yet look at the home page please do so!
  • Look into the contributing guidelines
  • Look into the issue tracker and pick an easy task.
  • Say hello in the issue you are interested in participating, or create a new issue.
  • Create a PR which solves the task as good as you can.
  • We will give you further feedback how you can improve.