| 1 | [Indefero][idf] is not only a software you can use either hosted for␊ |
| 2 | you or hosted by you, but also a free software you can contribute to. ␊ |
| 3 | ␊ |
| 4 | Here you will get how to contribute and what to contribute.␊ |
| 5 | ␊ |
| 6 | [idf]: http://www.indefero.net ␊ |
| 7 | ␊ |
| 8 | # Quick Way on How to Contribute␊ |
| 9 | ␊ |
| 10 | Simple contribution:␊ |
| 11 | ␊ |
| 12 | 1. Open a ticket with your idea. You can directly propose a patch if␊ |
| 13 | you have it.␊ |
| 14 | ␊ |
| 15 | 2. Wait for it to be checked by the devs or meet us on the #indefero␊ |
| 16 | channel on [FreeNode][freenode].␊ |
| 17 | ␊ |
| 18 | Bigger contribution:␊ |
| 19 | ␊ |
| 20 | 1. Fork Indefero where you want (fork from the develop branch).␊ |
| 21 | ␊ |
| 22 | 2. Code your change and document it.␊ |
| 23 | ␊ |
| 24 | 3. Open a ticket with a pull request and talk about it on IRC.␊ |
| 25 | ␊ |
| 26 | # The General Contribution Workflow for Regular Contributors␊ |
| 27 | ␊ |
| 28 | 1. Fork Indefero from the **develop** branch.␊ |
| 29 | 2. Request a pull request if you do not have write access on the repository.␊ |
| 30 | 3. Merge your changes without fast forward in develop. This keeps track of ␊ |
| 31 | the history of the changes and makes understanding what is going on easy.␊ |
| 32 | 4. Merge your changes with fast forward **only if a single commit**.␊ |
| 33 | ␊ |
| 34 | Indefero is composed of two main branches:␊ |
| 35 | ␊ |
| 36 | 1. **master**: this is the shipped branch, only a select number of people␊ |
| 37 | can push into it.␊ |
| 38 | 2. **develop**: this is the development branch, all the people having write␊ |
| 39 | access to the repository are welcomed to push in.␊ |
| 40 | ␊ |
| 41 | **Note:** The branching model we use is [explained in details here][bmi]. You␊ |
| 42 | **must** understand it to really contribute to the code base in an␊ |
| 43 | efficient way. ␊ |
| 44 | ␊ |
| 45 | [bmi]: http://nvie.com/git-model "A successful Git branching model"␊ |
| 46 | ␊ |
| 47 | # What to Contribute␊ |
| 48 | ␊ |
| 49 | Contribution is easy, you can contribute in a lot of different fields,␊ |
| 50 | contributions small or big are always appreciated. Here is an example␊ |
| 51 | list of what you can do:␊ |
| 52 | ␊ |
| 53 | - Install InDefero on your system and report the problem you had.␊ |
| 54 | - Find the bad English and typos and propose corrections.␊ |
| 55 | - Help with the translation effort.␊ |
| 56 | - Find little bugs or usability problems and provide ideas on how to fix them.␊ |
| 57 | - Register to the [discussion group][group] and help new users.␊ |
| 58 | - Come and chat on IRC #indefero on the [FreeNode][freenode] servers.␊ |
| 59 | - Find ways to improve the design while keeping it **beautifully simple**.␊ |
| 60 | - Write a blog post about the project, what you think is good or bad.␊ |
| 61 | - Translate InDefero for the sake of the community.␊ |
| 62 | - Or maybe really hack into the code.␊ |
| 63 | ␊ |
| 64 | As you can see, the real hacking into the code is just a small part of the work, so even if you are not a coder you can do a lot.␊ |
| 65 | ␊ |
| 66 | [group]: http://groups.google.com/group/indefero-users␊ |
| 67 | [freenode]: http://freenode.net/ ␊ |
| 68 | ␊ |
| 69 | ## I am a simple user␊ |
| 70 | ␊ |
| 71 | Thanks a lot! Really! As a project leader, I consider **you** as ␊ |
| 72 | **the most important person in the success of the project**. So do not␊ |
| 73 | worry, I will really listen to your needs and make you love this␊ |
| 74 | project.␊ |
| 75 | ␊ |
| 76 | What you can do to help:␊ |
| 77 | ␊ |
| 78 | - Use the software and each time you find something a bit annoying in your daily use, report a bug. Usability issues are high priority issues.␊ |
| 79 | - Find typos, grammar mistakes, etc. and report a bug.␊ |
| 80 | - Write about InDefero on your blog/website.␊ |
| 81 | - Read the issues submitted by the users and provide answers if you have them.␊ |
| 82 | - ...␊ |
| 83 | ␊ |
| 84 | ## I am a designer␊ |
| 85 | ␊ |
| 86 | A lot of things to do for you:␊ |
| 87 | ␊ |
| 88 | - Check the design and find the flaws in it. Is the space well used, does it look really nice and is it also functional for the first users?␊ |
| 89 | - Do we have good support of all the major browsers?␊ |
| 90 | - ...␊ |
| 91 | ␊ |
| 92 | ## I am a coder␊ |
| 93 | ␊ |
| 94 | Checkout the code and have fun, but keep in mind that your results␊ |
| 95 | must be simple to use. Do not worry about the beautiful part, the␊ |
| 96 | designers can work on that.␊ |
| 97 | ␊ |
| 98 | ## I am a security guy␊ |
| 99 | ␊ |
| 100 | Please, do try to break it, if you find a problem, come on IRC or␊ |
| 101 | contact the developers to get the issue fixed as soon as␊ |
| 102 | possible. Please, be nice, do not release the issue in the wild␊ |
| 103 | without first talking to us.␊ |
| 104 | ␊ |
| 105 | ## I am a translator␊ |
| 106 | ␊ |
| 107 | We currently use (transifex)[http://trac.transifex.org] to help our␊ |
| 108 | users to translate indefero. You don't have to use it, but it's an␊ |
| 109 | easy way to do the job. You can visit the indefero page at transifex␊ |
| 110 | here : http://www.transifex.net/projects/p/indefero/c/indefero/␊ |
| 111 | ␊ |
| 112 | Please understand that your changes will not be commited instantly,␊ |
| 113 | but are sent to the maintainers e-mails before. Then, your changes␊ |
| 114 | will not be in the main repository until da-loic push the changes. In␊ |
| 115 | that way, try to do big changes with less submissions. |
