codekingpro/portable-devtools
114k
1
2
3<!DOCTYPE html>
4
5<html lang="en" data-content_root="./">
6 <head>
7 <meta charset="utf-8" />
8 <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
9
10 <title>Submitting Pull Requests — pgAdmin 4 8.6 documentation</title>
11 <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
12 <link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
13
14 <script src="_static/documentation_options.js?v=d4c83366"></script>
15 <script src="_static/doctools.js?v=9a2dae69"></script>
16 <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
17
18 <script src="_static/sidebar.js"></script>
19
20 <link rel="index" title="Index" href="genindex.html" />
21 <link rel="search" title="Search" href="search.html" />
22 <link rel="next" title="Code Overview" href="code_overview.html" />
23 <link rel="prev" title="pgAdmin Project Contributions" href="contributions.html" />
24 </head><body>
25 <div class="related" role="navigation" aria-label="related navigation">
26 <h3>Navigation</h3>
27 <ul>
28 <li class="right" style="margin-right: 10px">
29 <a href="genindex.html" title="General Index"
30 accesskey="I">index</a></li>
31 <li class="right" >
32 <a href="code_overview.html" title="Code Overview"
33 accesskey="N">next</a> |</li>
34 <li class="right" >
35 <a href="contributions.html" title="pgAdmin Project Contributions"
36 accesskey="P">previous</a> |</li>
37 <li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
38 <li class="nav-item nav-item-1"><a href="contributions.html" accesskey="U">pgAdmin Project Contributions</a> »</li>
39 <li class="nav-item nav-item-this"><a href="">Submitting Pull Requests</a></li>
40 </ul>
41 </div>
42
43 <div class="document">
44 <div class="documentwrapper">
45 <div class="bodywrapper">
46 <div class="body" role="main">
47
48 <section id="submitting-pull-requests">
49<span id="id1"></span><h1><span class="target" id="index-0"></span>Submitting Pull Requests<a class="headerlink" href="#submitting-pull-requests" title="Link to this heading">¶</a></h1>
50<p>Before developing a feature or bug fix for pgAdmin you should always contact
51the developers on the mailing list <a class="reference external" href="mailto:pgadmin-hackers%40postgresql.org">pgadmin-hackers<span>@</span>postgresql<span>.</span>org</a> to discuss
52your plans. This ensures that others know what you are doing and can then
53avoid duplicating your work, and in the case of large changes, gives the
54community the chance to discuss and refine your ideas before investing too
55much time writing code that may later be rejected.</p>
56<p>You should always develop changes against a checkout of the source code from
57the GIT source code repository, and not a release tarball. This ensures that
58you’re working with the latest code on the branch and makes it easier to
59generate Pull Requests correctly.</p>
60<p>As of September 2022, the pgAdmin source repository can found at
61<a class="reference external" href="https://github.com/pgadmin-org/pgadmin4">https://github.com/pgadmin-org/pgadmin4</a>. A typical workflow for a relatively
62simple change might look as follows:</p>
63<ol class="arabic simple">
64<li><p>Visit the pgAdmin 4 project on GitHub, and click the <em>Fork</em> button to create
65your own development repository in your GitHub account.</p></li>
66<li><p>Checkout a local copy of the source code with a command like:</p></li>
67</ol>
68<blockquote>
69<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/<your<span class="w"> </span>GitHub<span class="w"> </span>username>/pgadmin4.git
70</pre></div>
71</div>
72</div></blockquote>
73<ol class="arabic" start="3">
74<li><p>Develop and test your change in your local development environment.</p></li>
75<li><p>Review your changes and check them thoroughly to ensure they meet the
76pgAdmin <a class="reference internal" href="coding_standards.html"><span class="doc">Coding Standards</span></a>, and review them against the
77<a class="reference internal" href="code_review.html"><span class="doc">Code Review Notes</span></a> to minimise the chances of them being rejected.</p></li>
78<li><p>Once you’re happy with your change, commit it with a suitable message.
79Include a one-line summary at the top, and if appropriate, further
80paragraphs following a blank line after the summary.</p></li>
81<li><p>Push your changes to your fork of the repository.</p></li>
82<li><p>Back in GitHub, create a new Pull Request against the <em>pgadmin-org/pgadmin4</em>
83<em>master</em> branch.</p>
84<div class="admonition note">
85<p class="admonition-title">Note</p>
86<p>Each Pull Request should encompass a single bug fix or feature as a single
87commit. If necessary, you should squash multiple commits for larger changes
88or features into a single commit before submitting.</p>
89</div>
90</li>
91<li><p>Your Pull Request will be reviewed by one or more members of the development
92team and either accepted or sent back with requested changes. In some cases
93it may be rejected if the change is not considered appropriate - this is
94why it’s important to discuss your work with the team before spending any
95significant time on it.</p></li>
96</ol>
97<p>For more complex changes, you may wish to use a <em>Feature Branch</em> in your fork
98of the pgAdmin repository, and use that to create the Pull Request.</p>
99<div class="admonition note">
100<p class="admonition-title">Note</p>
101<p>This is a simple example of a workflow. You may choose to use other
102tools such as the <a class="reference external" href="https://cli.github.com">GitHub CLI</a> instead; documenting
103such tools and workflows is outside the scope of the pgAdmin documentation
104however.</p>
105</div>
106</section>
107
108
109 <div class="clearer"></div>
110 </div>
111 </div>
112 </div>
113 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
114 <div class="sphinxsidebarwrapper">
115<h3><a href="index.html">Table of Contents</a></h3>
116<ul class="current">
117<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
118<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
119<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
120<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
121<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
122<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
123<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
124<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
125<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
126<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
127<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
128<li class="toctree-l1 current"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a><ul class="current">
129<li class="toctree-l2 current"><a class="current reference internal" href="#">Submitting Pull Requests</a></li>
130<li class="toctree-l2"><a class="reference internal" href="code_overview.html">Code Overview</a></li>
131<li class="toctree-l2"><a class="reference internal" href="coding_standards.html">Coding Standards</a></li>
132<li class="toctree-l2"><a class="reference internal" href="code_snippets.html">Code Snippets</a></li>
133<li class="toctree-l2"><a class="reference internal" href="code_review.html">Code Review Notes</a></li>
134<li class="toctree-l2"><a class="reference internal" href="translations.html">Translations</a></li>
135</ul>
136</li>
137<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
138<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
139</ul>
140
141<search id="searchbox" style="display: none" role="search">
142 <h3 id="searchlabel">Quick search</h3>
143 <div class="searchformwrapper">
144 <form class="search" action="search.html" method="get">
145 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
146 <input type="submit" value="Go" />
147 </form>
148 </div>
149</search>
150<script>document.getElementById('searchbox').style.display = "block"</script>
151 </div>
152<div id="sidebarbutton" title="Collapse sidebar">
153<span>«</span>
154</div>
155
156 </div>
157 <div class="clearer"></div>
158 </div>
159 <div class="related" role="navigation" aria-label="related navigation">
160 <h3>Navigation</h3>
161 <ul>
162 <li class="right" style="margin-right: 10px">
163 <a href="genindex.html" title="General Index"
164 >index</a></li>
165 <li class="right" >
166 <a href="code_overview.html" title="Code Overview"
167 >next</a> |</li>
168 <li class="right" >
169 <a href="contributions.html" title="pgAdmin Project Contributions"
170 >previous</a> |</li>
171 <li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
172 <li class="nav-item nav-item-1"><a href="contributions.html" >pgAdmin Project Contributions</a> »</li>
173 <li class="nav-item nav-item-this"><a href="">Submitting Pull Requests</a></li>
174 </ul>
175 </div>
176 <div class="footer" role="contentinfo">
177 <div class="related" role="navigation" aria-label="related navigation">
178 <ul>
179 <li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
180 <li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
181 <li class="right" ><a href="code_overview.html" title="Code Overview" accesskey="N">next</a> |</li>
182 <li class="right" ><a href="contributions.html" title="pgAdmin Project Contributions" accesskey="P">previous</a> |</li>
183 </ul>
184 </div>
185 </div>
186 </body>
187</html>