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 |
b89c7e
|
20 |
reported and/or fixed. [Search now for issues](https://github.com/projectfork/Translations/search?ref=cmdform&type=Issues) |
c198fa
|
21 |
|
b89c7e
|
22 |
3. **Isolate the problem** — ideally create a live example. _(Issues related to the 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 |
|
b89c7e
|
31 |
Example Language Files: |
LM |
32 |
|
|
33 |
> **Title** |
|
34 |
> Short and descriptive example bug report title (such as _Missing or unupdated language string_) |
|
35 |
> |
|
36 |
> **Comment**: |
|
37 |
> Joomla Version: _3.2.1_ |
|
38 |
> Projectfork Version: _4.2.0_ |
|
39 |
> Language Pack Version: _4.2.0.3_ |
|
40 |
> |
|
41 |
> 1. This is the first step (eg _Go to the backend, click on repository and you will see at the top the untranslated string_) |
|
42 |
> 2. This is the second step (_This string is also located in the frontend. Click here... there... etc....) |
|
43 |
> 3. Further steps, etc. |
|
44 |
> |
|
45 |
> You can also share a screenshot with ease. |
|
46 |
> Just do a screenshot, drag & drop the file/screenshot in the github comment textarea |
|
47 |
> Or if you're screenshot is in the clipboard, just paste it in the comment textarea |
|
48 |
> |
|
49 |
> Any other information you want to share that is relevant to the issue being |
|
50 |
> reported. This might include the lines of code that you have identified as |
|
51 |
> causing the bug, and potential solutions (and your opinions on their merits). |
|
52 |
|
|
53 |
|
|
54 |
Example Language pack Installer: |
c198fa
|
55 |
|
LM |
56 |
> Short and descriptive example bug report title |
|
57 |
> |
c10bde
|
58 |
> A summary of the issue and the browser/Joomla version/Projectfork version/PHP version in which it occurs. If |
c198fa
|
59 |
> suitable, include the steps required to reproduce the bug. |
LM |
60 |
> |
|
61 |
> 1. This is the first step |
|
62 |
> 2. This is the second step |
|
63 |
> 3. Further steps, etc. |
|
64 |
> |
|
65 |
> |
|
66 |
> Any other information you want to share that is relevant to the issue being |
|
67 |
> reported. This might include the lines of code that you have identified as |
c10bde
|
68 |
> causing the bug, and potential solutions (and your opinions on their merits). |
c198fa
|
69 |
|
c10bde
|
70 |
## Feature requests |
c198fa
|
71 |
|
c10bde
|
72 |
Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of Projectfork. |
LM |
73 |
|
|
74 |
|
|
75 |
## Language requests |
|
76 |
|
|
77 |
Please note that all translations are created and maintained by community members. |
|
78 |
That you request a new or an update of existing language does not mean it is automatically included in a future versions. |
|
79 |
You can help to translate Projectfork |
|
80 |
|
|
81 |
### Pull requests |
c198fa
|
82 |
|
LM |
83 |
**Please ask first** before embarking on any significant pull request (e.g. |
c10bde
|
84 |
implementing new language, refactoring code), otherwise you risk spending a lot |
LM |
85 |
of time working on something that the project's developers might not want to |
|
86 |
merge into the project. |
c198fa
|
87 |
|
2ec5fd
|
88 |
If you want to **be a part of the Projectfork Translation Team**, please have a look at |
LM |
89 |
the wiki => [Getting Involved](wiki/Getting-involved). |
c198fa
|
90 |
|
LM |
91 |
**IMPORTANT**: By submitting a patch, you agree to allow the project owner to |
|
92 |
license your work under the same license as that used by the project. |