| commit | author | age | ||
| c198fa | 1 | # Contributing to Projectfork Translations |
| LM | 2 | |
| 3 | Please take a moment to review this document in order to make the contribution | |
| 4 | process easy and effective for everyone involved. | |
| 5 | ||
| 6 | ||
| 7 | ## Using the issue tracker | |
| c10bde | 8 | The issue tracker is the preferred channel for bug reports and submitting pull requests |
| c198fa | 9 | |
| LM | 10 | ## Bug reports |
| 11 | A bug is a _demonstrable problem_ that is caused by the code in the repository. | |
| 12 | Good bug reports are extremely helpful - thank you! | |
| 13 | ||
| 14 | Guidelines for bug reports: | |
| 15 | ||
| 16 | 1. **Check if an update is available** — Purge Cache in *Joomla => Extension | |
| 17 | Manager => Update => Purge Cache*. After that, click *Find Updates* | |
| 18 | ||
| 19 | 2. **Use the GitHub issue search** — check if the issue has already been | |
| c10bde | 20 | reported and/or fixed. |
| c198fa | 21 | |
| c10bde | 22 | 3. **Isolate the problem** — ideally create a live example. _(Language Pack Installer only)_ |
| c198fa | 23 | |
| LM | 24 | |
| 25 | A good bug report shouldn't leave others needing to chase you up for more | |
| 26 | information. Please try to be as detailed as possible in your report. What is | |
| c10bde | 27 | your environment? What steps will reproduce the issue? What browser(s), Projectfork, |
| LM | 28 | Joomla and PHP version experience the problem? What would you expect to be the outcome? |
| 29 | All these details will help people to fix any potential bugs. | |
| c198fa | 30 | |
| LM | 31 | Example: |
| 32 | ||
| 33 | > Short and descriptive example bug report title | |
| 34 | > | |
| c10bde | 35 | > A summary of the issue and the browser/Joomla version/Projectfork version/PHP version in which it occurs. If |
| c198fa | 36 | > suitable, include the steps required to reproduce the bug. |
| LM | 37 | > |
| 38 | > 1. This is the first step | |
| 39 | > 2. This is the second step | |
| 40 | > 3. Further steps, etc. | |
| 41 | > | |
| 42 | > | |
| 43 | > Any other information you want to share that is relevant to the issue being | |
| 44 | > reported. This might include the lines of code that you have identified as | |
| c10bde | 45 | > causing the bug, and potential solutions (and your opinions on their merits). |
| c198fa | 46 | |
| LM | 47 | |
| c10bde | 48 | ## Feature requests |
| c198fa | 49 | |
| c10bde | 50 | Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of Projectfork. |
| LM | 51 | |
| 52 | ||
| 53 | ## Language requests | |
| 54 | ||
| 55 | Please note that all translations are created and maintained by community members. | |
| 56 | That you request a new or an update of existing language does not mean it is automatically included in a future versions. | |
| 57 | You can help to translate Projectfork | |
| 58 | ||
| 59 | ### Pull requests | |
| c198fa | 60 | |
| LM | 61 | **Please ask first** before embarking on any significant pull request (e.g. |
| c10bde | 62 | implementing new language, refactoring code), otherwise you risk spending a lot |
| LM | 63 | of time working on something that the project's developers might not want to |
| 64 | merge into the project. | |
| c198fa | 65 | |
| 2ec5fd | 66 | If you want to **be a part of the Projectfork Translation Team**, please have a look at |
| LM | 67 | the wiki => [Getting Involved](wiki/Getting-involved). |
| c198fa | 68 | |
| LM | 69 | **IMPORTANT**: By submitting a patch, you agree to allow the project owner to |
| 70 | license your work under the same license as that used by the project. | |
