How to contribute to Jelix
You are interested by the project? You want to help to the project but you don't know how to contribute? This page is for you.
You can help in different manners, depending of your free time, your skills etc:
- Use and test the framework
- Propose patch to correct bugs or to provide new features
- Review and write documentation
- Help on the developement of the web sites of jelix (jelix.org)
Use and test the framework
The project uses some processes to limit the number of bugs: unit testing, peer-review on patches etc. But this is not enough, and help is needed to test the framework in "real use" in order to track down bugs hidden, or to discover some gaps in components.
So, using Jelix, finding and report bugs (by creating tickets or by discussing in the forum) is really a great help. Even if you are a beginner in PHP or in the use of a framework, (I would say, especially if you are a beginner), or if you are an expert, your opinions, your feedback are important to us! Even the most critical!
You can also read the code. This is a good way to check the quality of code and then point out the shortcomings or potential improvements. It also allows you to propose patch later ;-)
Correct bugs or suggest improvements
There are two possible cases. The first is when you discover a bug or an improvement to do, during your use of Jelix, and you have decided to fix this bug or to make this improvement. Then create a ticket (by checking first if it does not already exist), and propose your patch (see how).
The second case is that you want to help close tickets. There is a list of many things to do, whether bug fixes, suggestions for improvements, or simple tasks. If you have time to devote to jelix, pick among these tickets, one that interests you, then assign this ticket to you, and submit a patch that corresponds to what is indicated on the ticket.
One thing to know is that if the ticket is selected for a subsequent version to the next version (ie several months), don't hesitate! Contribute on this ticket, and there are chances that it will be integrated earlier in the next release!
If you can not decide on the ticket to choose, here are some ideas:
- Try to search for tickets on a list of those concerns a part of Jelix you know quite well.
- If you want to start with easy patch, look at the tickets which are highlighted in blue in the lists, they are generally simpler (but not always true)
- You can also choose the tickets the most urgent need: those in red or yellow, and primarily those who are assigned in future versions.
- You can also ask other developers, they can possibly help you.
After a few successful proposals patches, you will be part of the team of Jelix developers who have write access to the repository, and you may even have responsibility for specific parts Jelix if it turns out that you were a specialty ;-)
Review and prepare documentation
The documentation is always a time delay on the current draft. Blame the lack of time often. Help us write documentation is a great help, and this may be a way to help you while you do not have enough time to develop. What you can do on the documentation:
- Read: it is always useful to have readers who correct typos, spelling errors etc.
- Complete: sometimes there are parts which are not always updated. It can be an opportunity to deep a bit into the code of Jelix to see if the documentation on this or that part is complete. There are a list of features that need to be documented.
- Edit: there are unfortunately some part of the framework that are not documented. It's time to highlight them!
Note: If you complete or correct a section of documentation, made these changes if possible in the two versions: English and French.
If you want to translate the manual in an other language. No problem. The documentation is a wiki!
For the english part of the documentation, there are some guidelines to follow while writing documentation.
Like Jelix? Say it then on other websites, on your blog, on forums for developers, to colleagues etc :-)
Advertising is a way to contribute, as the project is more and more known, and then there are more and more potential contributors, and thus to further improve the framework ;-)
Assist in development of project sites
The sources of the site is not available publicly. However, you can submit ideas for improvements, report in the shell design, in the content that you can edit. You can also suggest improvements in design. Then you will have an access to the repository.