bloomreach-forge.github.io/development.html at master · bloomreach-forge/bloomreach-forge.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
<!DOCTYPE html>
    <!--
 | Generated by Apache Maven Doxia Site Renderer 2.0.0 at 5 Jun 2026
 | Rendered using Bloomreach Forge Maven Skin 3.2.2 based on Apache Maven Fluido Skin
-->

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="" lang="">
<head>
  <meta charset="UTF-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
                      <meta http-equiv="Content-Language" content="" />
      <title>Development – Bloomreach Forge Documentation</title>
  <link rel="stylesheet" href="./css/forge-maven-skin-syntaxhighlighter-3.2.2.min.css"/>
  <link rel="stylesheet" href="./css/forge-maven-skin-3.2.2.min.css"/>
  <link rel="stylesheet" href="./css/site.css" />
  <link rel="stylesheet" href="./css/print.css" media="print" />
  <link rel="icon" type="image/png" href="./images/skin/logo_64.png" sizes="64x64">


  <script type="text/javascript" src="./js/forge-maven-skin-syntaxhighlighter-3.2.2.min.js"></script>
  <script type="text/javascript" src="./js/forge-maven-skin-3.2.2.min.js"></script>

            <style>.github-fork-ribbon:before { background-color: green; }</style>
</head>
<body class="topBarDisabled">
              <a target="_blank" class="github-fork-ribbon right" href="https://github.com/bloomreach-forge/bloomreach-forge.github.io"
     data-ribbon="Fork me on GitHub" title="Fork me on GitHub">Fork me on GitHub</a>
          <div class="container-fluid">
  <div id="banner">
    <div id="logo">
                        <a href="https://bloomreach-forge.github.io">
        <img src="./images/skin/logo.png" alt="Bloomreach Forge Logo" />
      </a>
    </div>
    <div class="pull-left">                    <h1>        Bloomreach Forge Documentation
        </h1>            </div>
    <div class="pull-right"></div>
    <div class="clear"><hr/></div>
  </div>

  <div id="breadcrumbs">
                            <div class="links">
      <a href="https://xmdocumentation.bloomreach.com">xmdocumentation.bloomreach.com</a>
      <a href="https://github.com/bloomreach-forge">github.com/bloomreach-forge</a>
    </div>
    <ul class="breadcrumb">

  <li id="publishDate">published: 5 Jun 2026
  </li>


            </ul>
    <div class="clear"><hr/></div>
  </div>
<div class="row-fluid">
  <div id="leftColumn" class="span2">
    <div class="well sidebar-nav">

    <ul class="nav nav-list">
            <li>  <a href="index.html" title="Home">  <span class="none"></span>  Home</a>  </li>
        <li>  <a href="project-list.html" title="Project List">  <span class="none"></span>  Project List</a>  </li>
        <li class="active">  <a href="#"><span class="none"></span>Development</a>
  </li>
        <li>  <a href="using-git-flow.html" title="Using Git Flow">  <span class="none"></span>  Using Git Flow</a>  </li>
        <li>  <a href="checklist.html" title="Quality Checklist">  <span class="none"></span>  Quality Checklist</a>  </li>
        </ul>

          <hr />
      <div id="poweredBy">
                <div class="clear"></div>
                <div class="clear"></div>
                <div class="clear"></div>
                <div class="clear"></div>
          <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">  <img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />  </a>
        </div>
    </div>
  </div>
  <div id="bodyColumn"  class="span10" >
    <section><section><a id="Development"></a>
<h2>Development</h2>
<p>On the Bloomreach Forge, plugins are developed and maintained by the Bloomreach Community, consisting of both developers from
Bloomreach and external developers, from partners and clients.</p>
<p>Forge projects can be maintained during the course of an implementation project. For instance, it is pretty common
for a plugin to be upgraded during a project upgrade. This also goes for new features or bug fixing.</p><section><a id="Code_Contributions"></a>
<h3>Code Contributions</h3>
<p>Code contributions are very much welcome! On GitHub, they exist mostly in the form of pull requests. External
organizations can drive those pull requests, or feature requests, or release requests by contacting the
<a href="https://www.bloomreach.com/en/services" class="externalLink">Bloomreach Services department</a>.</p>
<p>See the <a href="https://guides.github.com/activities/contributing-to-open-source/#contributing" class="externalLink">GitHub documentation on contributing</a>,
basically forking and developing in a separate branch.</p></section><section><a id="Forking"></a>
<h3>Forking</h3>
<p>Forking into other (non-Forge) GitHub locations is of course a possibility for further development on behalf of your
project. In fact, a fork is the starting point of a pull request!</p>
<p>See also the <a href="https://guides.github.com/activities/forking/" class="externalLink">GitHub documentation on forking</a>.</p></section><section><a id="Outside_Collaborators"></a>
<h3>Outside Collaborators</h3>
<p>External developers can also apply, or be asked for, the GitHub role of &#x2018;Outside Collaborator&#x2019; of a project. If that
occurs, an external developer has push rights on the repository.</p></section><section><a id="Branching_Strategy"></a>
<h3>Branching Strategy</h3>
<p>We like to adhere to the the well-established <a href="http://nvie.com/posts/a-successful-git-branching-model/" class="externalLink">Git Flow by Vincent Driessen</a>.</p>
<p>In short, the &#x2018;master&#x2019; branch is always the same as the latest release, whilst the &#x2018;develop&#x2019; branch is used as base for
features and bug fixes.  See <a href="using-git-flow.html">using git flow</a>.</p></section><section><a id="Artifact_Repository"></a>
<h3>Artifact Repository</h3>
<p>Artifacts can be retrieved from the Hippo Maven Forge Repository at <a href="http://maven.onehippo.com/maven2-forge/" class="externalLink">maven.onehippo.com/maven2-forge/</a>.</p>
<p>For publishing, the Maven <code>distributionManagement.repository.url</code> value is to be set at <code>https://maven.onehippo.com/content/repositories/forge-releases/</code>.
Only Bloomreach developers have the access rights to publish it here.</p></section><section><a id="Issue_Tracking"></a>
<h3>Issue Tracking</h3>
<p>The JIRA at <a href="https://issues.onehippo.com/browse/HIPFORGE" class="externalLink">issues.onehippo.com/browse/HIPFORGE</a>.</p></section><section><a id="Continuous_Integration"></a>
<h3>Continuous Integration</h3>
<p>Travis at <a href="https://travis-ci.org/bloomreach-forge/" class="externalLink">travis-ci.org/bloomreach-forge/</a>.</p></section></section></section>
    </div>
    </div>
    </div>
    <hr/>
    <footer>
    <div class="container-fluid">
      <div class="row-fluid">
          <p class="copyright">Copyright &copy;      2017&#x2013;2026.
          <a href="https://www.bloomreach.com">Bloomreach Inc.</a>.

</p>
    </div>
            </div>
  </footer>
    </body>
</html>