12. Contribute

12.1. How to Report an Issue

An Official Bug Tracker accepts any issue report or suggestion related to the application or an official package.

Here are some guidelines to report an issue. Please follow them! To accurately report an issue strongly increases the chances of your issue to be fixed quickly.

  • First search if your issue has already been reported
  • Provide the exact and complete version number of the application. You can get it by displaying the Console (scroll up to the top lines)
  • One bug per report
  • Describe the issue clearly, with simple language, in English (bullet points are good)
  • Provide step-by-step instructions so we can reproduce the issue (we can’t fix what we can’t reproduce).
    • What steps will reproduce the problem?
    • What is the expected output/behavior?
    • What do you see instead?
  • Optionally attach screenshots so we can “see” the issue
  • Optionally attach the complete log of the session during which the bug occurred (the log indicates critical information including the complete version number).
    Note that you may want to strip the log file first since it may contain several sessions.
  • Workarounds or other related tips on how to avoid the issue are welcome

12.2. Get involved in the development of the Packages

If you are interested in improving an official package, the Packages Repository is online and accepts pull requests.

12.3. Get involved in the development of the Platform

Keypirinha is looking for a skilled developer to help creating its online platform dedicated to the automated redistribution of plugins (i.e. website and service).

The project

  • Code would be fully open source
  • It mainly consists of a website and a service to be accessed by Keypirinha itself. Pretty much like Package Control for SublimeText, or Packal for Alfred
  • It will include current Keypirinha‘s website (documentation)
  • Its main language would be Python3
  • It must run on a Linux platform

About you

  • You want to improve Keypirinha
  • You have a crystal clear view of the requirements for such a task
  • You want to volunteer and spend some of your free time on a long run project
  • You are of the kind who like to get the job done
  • You are willing to enter a friendly online relationship with an other developer for the good of a project :)

Application

Please PM @polyvertex and provide some info about your background. Links to your code repositories are welcome.

@polyvertex is a former long-time traveler who values humanized and friendly online relationships between developers. Having a beer (or five) with him somewhere, someday, is a non-negociable requirement to your application :)

12.4. Help with the Documentation

Documentation’s repository is not open yet, but please file an issue on the Official Bug Tracker if you noticed a mistake or if you have some comments.