aboutsummaryrefslogtreecommitdiffstats
path: root/src/documentation/content/xdocs/devel/git.xml
blob: a17fdc70f7de7d6c7db740d7eea4fc06c0e263db (plain)
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
<?xml version="1.0" encoding="UTF-8"?>
<!--
   ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-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.
   ====================================================================
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "document-v20.dtd">

<document>
  <header>
    <title>Apache POI™ - Source Code Repository</title>
    <authors>
      <person id="NB" name="Nick Burch" email="dev@poi.apache.org"/>
    </authors>
  </header>

  <body>
    <section><title>Download the Source</title>
      <p>
         Most users of the source code probably don't need to have day to
         day access to the source code as it changes. Therefore most users will want
         to make use of our <a href="site:download">source release</a>
         packages, which contain the complete source tree for each binary
         release, suitable for browsing or debugging. These source releases
         are available from our
         <a href="site:download">download page.</a>
      </p>
      <p>
         The Apache POI source code is also available as source artifacts
         in the <a href="https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.poi%22">Maven Central repository</a>,
         which may be helpful for those users who make use of POI via Maven
         and wish to inspect the source (eg when debugging in an IDE).
      </p>
    </section>
    <section><title>Access the Version Controlled Source Code</title>
      <p>Apache POI uses Git as its version control system. We switched from Subversion to Git
        in July 2025.
      </p>

      <ul>
       <li>For access to the latest Apache POI code, please use
        <a href="https://github.com/apache/poi/tree/trunk/">https://github.com/apache/poi/tree/trunk/</a></li>
      </ul>

      <p>If you are not a <em>Committer</em>, but you want to submit patches
       or even request commit privileges, please see our
       <a href="site:guidelines">Contribution Guidelines</a> for more
       information.</p>
    </section>
    <section><title>Git access to POI sources</title>
      <p>
        The trunk source repository for Apache POI is in gitbox.apache.org.
        The GitHub mirror can be used to access the repo too (https://github.com/apache/poi).
        You can create PRs and issues using GitHub, if you like.
      </p>
    </section>
    <section><title>Code metrics</title>
      <p>
        Code quality reports for Apache POI are available on the
        <a href="https://sonarcloud.io/dashboard?id=poi-parent">Apache Sonar instance</a>.
      </p>
      <p>
        Sonar provides lots of useful numbers and statistics, especially
        watching the project over time shows how some of the indicators evolve
        and allows to see which areas need some polishing.
      </p>
    </section>
  </body>
  <footer>
    <legal>
      Copyright (c) @year@ The Apache Software Foundation. All rights reserved.
      <br />
      Apache POI, POI, Apache, the Apache feather logo, and the Apache
      POI project logo are trademarks of The Apache Software Foundation.
    </legal>
  </footer>
</document>