Menu

How to contribute

As you can imagine, we hope to involve as many people as possible in all phases of Fud project development - otherwise, why deciding to use a public git repository for our sources? :-)
Not by chance Fud is a free software and its code can be freely used, studied, modified and redistributed.
For that reason, the contribution of anyone interested in improving the program or in extending its features is welcome, of course in accordance with these guidelines and the license (see LICENSE file).

Code development

Requirements

Fud is written in Bash language.
The distributed revision control system used for the development of Fud is Git.
It allows us to:

  • share the source (distributed development), as our goal;
  • develop the project on different branches;
  • keep tracks of the history of project development.

To contribute then it is obviously necessary to have a minimum of confidence and with Git and Bash. To get started you can refer to the following documents:

Bash

Git

The remote repository of the project is hosted by SourceForge and is located at this address: to collaborate and participate in the development you need to register on SourceForge.

At work!

Start by creating a fork of our repository.
Consult our to-do list and the issues list.
After done this, start with the development on the trunk branch, which is normally the most updated available among the branches, or at least on one of its sub-branches.
Ignore instead the master branch, use it only to report bugs: it is the "stable" one, and so tested and proven changes coming from trunk branch and its sub-branches usually merge into it.

Contacts

Anyone wishing to contact us may do so by visiting the project home page, where you can find our email addresses: we will be very happy to share with you the changes you want to make to the project and we will be ready to be helpful for all indications or suggestions you will need.
If you want to make radical changes to the project, both qualitative (that radically change the functioning of Fud) both quantitative (that modify most of the code of Fud), we strongly recommend you to contact us from the beginning to avoid that these radical changes - if not programmed - are in the possibility of being applied to the project.

Beyond the code

Fud is not only code and software development. If you do not know programming, if you have no opportunity or the will to learn how to do it, however, take a look at our to-do list - there are many other things to do!

For example:

  • testing and debugging;
  • extension of our wiki (new guides, new information, new how-to);
  • translation of the pages of our wiki (generally we write new pages in italian language, that then must be translated at least in english. Not to mention other languages ​​such as french, german or spanish...);
  • verification of the correctness of the strings of the source code, including comments (tha should be all in english);
  • maintenance and updating of the Fud project site (which is the gh-pages branch of our repository);
  • various graphic works.

MongoDB Logo MongoDB