Skip to content

Latest commit

 

History

History
executable file
·
138 lines (99 loc) · 4.95 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
138 lines (99 loc) · 4.95 KB

Contributing to Open Classifieds

Looking to contribute something to Open Classifieds? Here's how you can help.

Environment

Recommended PHP 5.5 , MySQL 5.5, Apache 2.2, Linux.

For development we recommend you to create a vhost called 'reoc.lo' this will enable debug/profiler tools, disable cache and disable minify

Host file:
127.0.0.1   reoc.lo

Vhost apache:
<VirtualHost *:80>
ServerName reoc.lo
DocumentRoot /var/www/open-classifieds/
</VirtualHost>

Cloning repo

Go to https://github.com/open-classifieds for each repo in the top right theres a button that says Fork. Click there to clone each repo, don't forget to clone common. That will copy the repos to your github user, ex: https://github.com/neo22s?tab=repositories

Clone your project in local

git clone [email protected]:neo22s/openclassifieds2.git open-classifieds
cd open-classifieds
git submodule init
git submodule update

This will clone the openclassifieds2 project + submodule at oc/common https://github.com/open-classifieds/common

GIT files to ignore changes, DO NOT COMMIT THIS FILES:

git update-index --assume-unchanged robots.txt
git update-index --assume-unchanged oc/config/auth.php
git update-index --assume-unchanged oc/config/database.php
git update-index --assume-unchanged .htaccess
git update-index --assume-unchanged sitemap.xml.gz
git update-index --assume-unchanged sitemap.xml
git update-index --assume-unchanged install/install.lock
git update-index --assume-unchanged oc/cache/.empty
git update-index --assume-unchanged oc/logs/.empty
git update-index --assume-unchanged images/.empty
git update-index --assume-unchanged images/users/.empty
git update-index --assume-unchanged .gitmodules

Modify the hidden file .gitmodules, this is to track changes at the neo22s/common repo

Go to common module and change to branch master

cd oc/common
git checkout master

Ready ;)

How to commit

If you have made modifications to the code.

git status # to see what's going on
git commit -a -m 'message here, this will commit the changes on the tracked files'
git push origin master # will "upload" the changes to your repo

Tricks

git add . # will add all the files, even new ones
git add -u # will add all the tracked files even the deleted ones
git commit -a -m 'working on open-classifieds/openclassifieds#725' # this will mention an issue in the repo

If you made changes in any file located at oc/common (common submodule), you need to browse that directory since its a different repo. To commit works exactly the same.

Pull Requests

Now you have new code at your fork ex https://github.com/neo22s/common. To move them to the original https://github.com/open-classified/common repo you need to go to https://github.com/neo22s/common, and click on Pull Request (next to compare). This will create a pull request to the original code and the responsible will decide to merge it or not.

Notes:

  • Try to submit pull requests against master branch for easier merging
  • Try not to pollute your pull request with unintended changes--keep them simple and small
  • Try to share which browsers your code has been tested in before submitting a pull request

Keep sync with original repo

First time, add a remote with the upstream

git remote add upstream [email protected]:open-classifieds/openclassifieds2.git

Everytime you want to sync just

git fetch upstream
git merge upstream/master

Do the same for common repo if needed.

Remember to be at you master branch!

Reporting issues

https://github.com/open-classifieds/openclassifieds2/issues

We only accept issues that are bug reports or feature requests. Bugs must be isolated and reproducible problems that we can fix within the Open Classifieds core. Please read the following guidelines before opening any issue.

  1. Search for existing issues. We get a lot of duplicate issues, and you'd help us out a lot by first checking if someone else has reported the same issue. Moreover, the issue may have already been resolved with a fix available.
  2. Create an isolated and reproducible test case. Be sure the problem exists in Open Classifieds code.
  3. Include a live example. Make use of screenshots if needed.
  4. Share as much information as possible. Include operating system and version, browser and version, version of OC, customized or vanilla build, etc. where appropriate. Also include steps to reproduce the bug.

Key branches

  • master is the development branch.
  • We create tags per release from master branch. -We have many other branches not in use anymore since we changed the way we use the git flow.

Coding standards

License

By contributing your code, you agree to license your contribution under the terms of the GPLv3: Read LICENSE