Skip to content

Contribute to the project

Al'rind edited this page Jul 1, 2015 · 3 revisions

They are many ways to contribute to the projet. They are all warmly welcome. Don't hesitate if you find the project interesting.

Contributing without being a scripter

You don't have to be especially skilled in programming. In fact, as long as you are able to test commands et send us your feedbacks through this section, this will help us. You can create a new issue for commands that you have tested (and tell whether they are valid or not) or if you have find out bugs (even for spelling mistakes). Issues can be written in french, english or dutch.

Writing an issue

This way of writing is not mandatory, but advised to minimize loss of time. Of course, some cases are not told here, we have got confidence in your judgement to determine what is best:

  • Several tested and validated commands.

    Overall, it is not necessary to make an issue for each tested command. It is absolutely possible to make one issue for a variable number of tested commands (for instance, every 10 tested commands).

  • Bug detection

    As opposed to tested and validated commands, we will prefer here to have one issue for each detected bug. It will help us to define priority between bugs.

  • Features request

    If you think that the project lacks of a command or a tool, create an issue to speak about it.

Contributing as a scripter

You can obviously help us to fix bugs, through submitting "pull requests". You can also implement your own commands and submit them to us.

  • Every added command has to respect the logic of Command's module
  • Every added command has to be documented
  • If an experimental feature is added, it has to be written in the Incubator.rb file.

Read also : Wiki:Index:For the scripters

This file will be completed.

Clone this wiki locally