Access to add and change pages is restricted. See: https://cwiki.apache.org/confluence/display/OFBIZ/Wiki+access

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

Work in Progress

This document is a work in progress.

This document is intended to capture all aspects related to contributing via Git and Github. While being WIP this document can contain questions (gathered from experience, and posts via mailing lists and the Slack channel) to be addressed.


Suggested approaches

By Jacopo: https://rocketmq.apache.org/docs/pull-request/


Related mail threads

Git Repositories

The project maintains several repositories (codebases):

NameDescriptionPublic location
ofbiz-frameworkThe repository containing all base componentshttps://github.com/apache/ofbiz-framework
ofbiz-pluginsThe repository containing several pluginshttps://github.com/apache/ofbiz-plugins
ofbiz-siteThe repository containing the page of the official OFBiz sitehttps://github.com/apache/ofbiz-site
ofbiz-toolsThe repository containing several functions and services to maintain the project and its workshttps://github.com/apache/ofbiz-tools


Working with your own Git Clone

A Git clone is your remote git clone existing in your local environment.

Cloning is done through following commands in your cli:

Repocommand
ofbiz-framework
git clone https://github.com/apache/ofbiz-framework
ofbiz-plugins
git clone https://github.com/apache/ofbiz-plugins
ofbiz-site
git clone https://github.com/apache/ofbiz-site
ofbiz-tools
git clone https://github.com/apache/ofbiz-tools

Forking in Github

Forking the OFBiz repository in Github is - in essence - having your clone of the OFBiz repository in the Github environment, thereby being publicly available to the community and others.

This is done by clicking on the 'Fork' button on the repository's page in Github (see public locations above).

From here you can clone or download it to your local development environment (and use it within your preferred IDE). You can do this via the green 'Clone or Download' button on your repository page, or directly in your preferred location (folder) on your local environment, with a command similar to:

git clone https://github.com/<your_github_id>/ofbiz-framework.git


Contributing your changes to the project

Todo:

  • addressing patch files?
  • addressing interaction with JIRA - see below
  • addressing cherry-picking?
  • addressing pull requests? - see below

Git GUI Clients

Instead of working via the cli (terminal) that comes with your OS, you can also use dedicated Git GUI clients (software packages) to execute git commands.

An overview of clients available (for your os platform) can be found here: https://git-scm.com/downloads/guis

Of course, you can also use the git functionalities available in your IDE of choice (Apache Netbeans, Eclipse, IntelliJ, etc.)

Reporting Code Issues

The project's tool to report and track issues with code in the various repositories is JIRA (https://issues.apache.org/jira/projects/OFBIZ). 

While Github also offers functionality to report issues, there is no bidirectional way to sync these with JIRA. Therefore, it is advised to register issues in JIRA as tickets there appear in the project's mailing lists to reach its community members in a better way.

Pull Requests

Github Guide

Github workflow explanation: https://guides.github.com/introduction/flow/

TBD: Pull request template: https://help.github.com/en/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository

Pull requests (e.g. from Github) can be handled in the same way as patch files in a JIRA ticket. In general, patch files are downloaded from the ticket and then applied to a branch in the development environment (e.g. your IDE) for evaluation and testing purposes.



  • No labels