From 494917edf83c3d9e4bfa476532761887a3c8a20f Mon Sep 17 00:00:00 2001 From: Lahmizzar Muinela <lahmizzar@devxive.com> Date: Sun, 09 Mar 2014 17:34:17 -0400 Subject: [PATCH] chng 2 one-liner in xml code --- CONTRIBUTING.md | 135 +++++++++++++++------------------------------ 1 files changed, 45 insertions(+), 90 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c8d585f..76e455f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,24 +3,10 @@ Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved. -Following these guidelines helps to communicate that you respect the time of -the developers managing and developing this open source project. In return, -they should reciprocate that respect in addressing your issue or assessing -patches and features. - ## Using the issue tracker -The issue tracker is the preferred channel for [bug reports](#bugs) and -[submitting pull requests](#pull-requests), but please respect the following -restrictions: +The issue tracker is the preferred channel for bug reports and submitting pull requests -* Please **do not** use the issue tracker for personal support requests. - -* Please **do not** derail or troll issues. Keep the discussion on topic and - respect the opinions of others. - - -<a name="bugs"></a> ## Bug reports A bug is a _demonstrable problem_ that is caused by the code in the repository. Good bug reports are extremely helpful - thank you! @@ -31,107 +17,76 @@ Manager => Update => Purge Cache*. After that, click *Find Updates* 2. **Use the GitHub issue search** — check if the issue has already been - reported. + reported and/or fixed. [Search now for issues](https://github.com/projectfork/Translations/search?ref=cmdform&type=Issues) -3. **Check if the issue has been fixed** — try to reproduce it using the - latest `master` branch in the repository. - -4. *(Projectfork Language Pack Installer only)* **Isolate the problem** — ideally - create a [reduced test case](http://css-tricks.com/6263-reduced-test-cases/) and a - live example. +3. **Isolate the problem** — ideally create a live example. _(Issues related to the Language Pack Installer only)_ A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is -your environment? What steps will reproduce the issue? What browser(s) and OS -experience the problem? What would you expect to be the outcome? All these -details will help people to fix any potential bugs. +your environment? What steps will reproduce the issue? What browser(s), Projectfork, +Joomla and PHP version experience the problem? What would you expect to be the outcome? +All these details will help people to fix any potential bugs. -Example: +Example Language Files: + +> **Title** +> Short and descriptive example bug report title (such as _Missing or unupdated language string_) +> +> **Comment**: +> Joomla Version: _3.2.1_ +> Projectfork Version: _4.2.0_ +> Language Pack Version: _4.2.0.3_ +> +> 1. This is the first step (eg _Go to the backend, click on repository and you will see at the top the untranslated string_) +> 2. This is the second step (_This string is also located in the frontend. Click here... there... etc....) +> 3. Further steps, etc. +> +> You can also share a screenshot with ease. +> Just do a screenshot, drag & drop the file/screenshot in the github comment textarea +> Or if you're screenshot is in the clipboard, just paste it in the comment textarea +> +> Any other information you want to share that is relevant to the issue being +> reported. This might include the lines of code that you have identified as +> causing the bug, and potential solutions (and your opinions on their merits). + + +Example Language pack Installer: > Short and descriptive example bug report title > -> A summary of the issue and the browser/OS environment in which it occurs. If +> A summary of the issue and the browser/Joomla version/Projectfork version/PHP version in which it occurs. If > suitable, include the steps required to reproduce the bug. > > 1. This is the first step > 2. This is the second step > 3. Further steps, etc. > -> `<url>` - a link to the reduced test case > > Any other information you want to share that is relevant to the issue being > reported. This might include the lines of code that you have identified as -> causing the bug, and potential solutions (and your opinions on their -> merits). +> causing the bug, and potential solutions (and your opinions on their merits). + +## Feature requests + +Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of Projectfork. -<a name="pull-requests"></a> +## Language requests + +Please note that all translations are created and maintained by community members. +That you request a new or an update of existing language does not mean it is automatically included in a future versions. +You can help to translate Projectfork + ## Pull requests -Good pull requests - languages, patches, improvements, new features - are a fantastic -help. They should remain focused in scope and avoid containing unrelated commits. - **Please ask first** before embarking on any significant pull request (e.g. -implementing new language, refactoring code, porting to a different language), -otherwise you risk spending a lot of time working on something that the -project's developers might not want to merge into the project. +implementing new language, refactoring code), otherwise you risk spending a lot +of time working on something that the project's developers might not want to +merge into the project. If you want to **be a part of the Projectfork Translation Team**, please have a look at the wiki => [Getting Involved](wiki/Getting-involved). - -Please adhere to the coding conventions used throughout a project (indentation, -accurate comments, etc.) and any other requirements (such as test coverage). - -Adhering to the following this process is the best way to get your work -included in the project: - -1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork, - and configure the remotes: - - ```bash - # Clone your fork of the repo into the current directory - git clone https://github.com/<your-username>/<repo-name> - # Navigate to the newly cloned directory - cd <repo-name> - # Assign the original repo to a remote called "upstream" - git remote add upstream https://github.com/<upstream-owner>/<repo-name> - ``` - -2. If you cloned a while ago, get the latest changes from upstream: - - ```bash - git checkout <dev-branch> - git pull upstream <dev-branch> - ``` - -3. Create a new topic branch (off the main project development branch) to - contain your feature, change, or fix: - - ```bash - git checkout -b <topic-branch-name> - ``` - -4. Commit your changes in logical chunks. Please adhere to these [git commit - message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) - or your code is unlikely be merged into the main project. Use Git's - [interactive rebase](https://help.github.com/articles/interactive-rebase) - feature to tidy up your commits before making them public. - -5. Locally merge (or rebase) the upstream development branch into your topic branch: - - ```bash - git pull [--rebase] upstream <dev-branch> - ``` - -6. Push your topic branch up to your fork: - - ```bash - git push origin <topic-branch-name> - ``` - -7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) - with a clear title and description. **IMPORTANT**: By submitting a patch, you agree to allow the project owner to license your work under the same license as that used by the project. -- Gitblit v1.9.1