From c198fa9d7055e09b84650a41920c1e1f68958769 Mon Sep 17 00:00:00 2001 From: Lahmizzar Muinela <lahmizzar@devxive.com> Date: Wed, 24 Apr 2013 14:06:41 -0400 Subject: [PATCH] update readme, add contributing - new guidance --- CONTRIBUTING.md | 134 +++++++++++++++++++++++++++++++++ README.md | 53 ++++++++++++- 2 files changed, 182 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9acf401 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,134 @@ +# Contributing to Projectfork Translations + +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: + +* 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! + +Guidelines for bug reports: + +1. **Check if an update is available** — Purge Cache in *Joomla => Extension + Manager => Update => Purge Cache*. After that, click *Find Updates* + +2. **Use the GitHub issue search** — check if the issue has already been + reported. + +3. **Check if the issue has been fixed** — try to reproduce it using the + latest `master` or development 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. + + +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. + +Example: + +> Short and descriptive example bug report title +> +> A summary of the issue and the browser/OS environment 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). + + +<a name="pull-requests"></a> +## 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. + +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. diff --git a/README.md b/README.md index 931c34f..1a0a23f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,50 @@ -<a href="https://projectfork.net"> - <img src="http://devxive.com/images/upload/github_projectfork-readme.png"> -</a> +# [Projectfork 4 Translations](https://projectfork.net) +Projectfork - a Joomla Project Management Software with milestones, tasks, files, calendar, discussions, timesheets, & so much more... -# [Projectfork v4 Translations](https://projectfork.net) -Projectfork 4 Translations package \ No newline at end of file +## Quick start +* Projectfork Language Pack - **[download the latest release](http://projectfork.net/downloads)** + +#### Stay up-to-date +*The Projectfork Language Pack* use the Joomla!-Updater + + +## Bug tracker +Have an issue related tho the *Projectfork Language Pack*? [Please open a new issue](https://github.com/projectfork/Translations/issues). Before opening any issue, please search for existing issues and read the [Issue Guidelines](CONTRIBUTING.md#bugs). + + +## Contributing +Anyone and everyone is welcome to contribute. Please take a moment to review the [guidelines for contributing](CONTRIBUTING.md) + +#### Language Package Installer +Please submit all [pull requests](CONTRIBUTING.md#pull-requests) against this `master` branch. + + +## Community +Keep track of development and community news. + +* Follow [@projectfork on Twitter](http://twitter.com/projectfork). +* Like [Projectfork on Facebook](http://facebook.com/projectfork). +* Subscribe to the [Projectfork Channel on Youtube](http://youtube.com/user/projectfork). +* Read and subscribe to the [The Official Projectfork Blog](https://projectfork.net/blog). + + + +#### Thanks! + + + +## Copyright and license +(c) 2012 - 2013 by the Projectfork Translation Team. All rights reserved. + +Licensed under the GNU General Public License, Version 2 (the "License"); +you may not use this work except in compliance with the License. +You may obtain a copy of the License in the LICENSE file, or at: + + [http://www.gnu.org/licenses/gpl-2.0](http://www.gnu.org/licenses/gpl-2.0) + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. \ No newline at end of file -- Gitblit v1.9.1