Open Source Contributions to Postgres: The Basics POSETTE 2024

Postgres is the most advanced open-source database in the world and it's supported by a community, not a single company. So how does this work? How does code actually get into Postgres? I recently had a patch submitted and committed and I want to share what I learned in that process. I’ll give you an overview of Postgres versions and how the underlying project codebase functions. I’ll also show you the process for submitting a patch and getting that tested and committed.

2. Hi there!Hi there!

3. Docs are important
Strengths
Weaknesses
Opportunities
for existing users
for releases
for adoption
incredible reference
manual
accuracy
above bar for open-
source
document new
features that connect
to other features
correct mistakes or
clarifications
lacks tutorials
lacks detailed
examples

4. architects
PostgresPostgres
needsneeds
lots oflots of
differentdifferent
peoplepeople
developers
dbas
data science
consultants
products

5. PostgresPostgres
Code BaseCode Base
Let’s review some of the basic processes, like:
Postgres version calendar
Where is the code?
Where do commits go?
How goes it get to end users?

7. Where is theWhere is the
Postgres code?Postgres code?

8. Where is theWhere is the
Postgres code?Postgres code?
https://github.com/postgres/postgreshttps://github.com/postgres/postgres
https://git.postgresql.org/https://git.postgresql.org/

11. git.postgresql.orggit.postgresql.org
is the actual code storeis the actual code store
oonly committers can pushnly committers can push

12. KeyKey
PostgresPostgres
CodeCode
TeamsTeams
Committers
Core Team
Release
management (RMT)

14. Patch ideasPatch ideas
What has been a problem for you?
Docs can be a good place to start
https://wiki.postgresql.org/wiki/Todo
Talk to people in Postgres

15. Potentially lots of discussion
of your ideas

16. BuildingBuilding
PostgresPostgres
locallylocally

17. Meson
https://www.postgresql.org/
docs/current/install-
meson.html
Make
https://www.postgresql.org/
docs/current/install-
make.html

18. > ninja docs
[3/3] Generating doc/src/sgml/html with a custom command
> meson setup build
The Meson build system
Version: 1.2.3
Source dir: /Users/elizabethgarrettchristensen/Documents/GitHub/2/postgres
Build dir: /Users/elizabethgarrettchristensen/Documents/GitHub/2/postgres/build
Build type: native build
Project name: postgresql
Project version: 17devel
> cd build
> brew install docbook-xsl

20. > sudo ninja install
> ninja test
> mkdir ~/pgsql-17-data
> initdb -D ~/pg-17-data
> psql postgres

22. > sudo ninja install
> ninja test
> mkdir ~/pgsql-17-data
> initdb -D ~/pg-17-data
> psql postgres
Regression tests

23. CodingCoding
conventionsconventions
https://wiki.postgresql.org/
wiki/Submitting_a_Patch

25. > git checkout -b elizabeth/docs-patch-idea-1
> git commit
> git format-patch -1 HEAD

26. v1-0001-Adding-Summary-Index-Info-to-HOT-Update-Documentation.patch

27. Postgres mailing lists
https://www.postgresql.org/list/
pgsql-novice
pgsql-general
pgsql-hackers
Beginner type questions
General list
Patch files and code discussions go here

28. List archives are onlineList archives are online
If you hate mailing lists .......

30. Every thread has a unique URL

31. Hackers
https://www.postgresql.org/list/
is a list you can submit to without subscribing to
has reply-all as default, so you’ll get replies about
your PATCH
Note: hackers is not for questions or newbies

32. PatchPatch
submissionsubmission
1 - Email patch file to Hackers
2 - Add patch to commitfest

33. CommitfestCommitfest
https://commitfest.postgresql.org/
You can add new patches here so they don’t get
lost
Lists of active patches, authors, reviewers, and committers
Active status and final outcome, rejected,
committed, withdrawn

36. Code reviewCode review
andand
testingtesting
conventions
/ re
unit testing / regression
really high standards

37. TipsTips
be prepared for lots of feedback
make this a learning experience
don’t take it personally
be patient

38. Getting aGetting a
commitcommit

39. Recent commitfestsRecent commitfests
26% committed26% committed

40. WhatWhat
happenshappens
next?next?

41. WhatWhat
happenshappens
next?next?
Both mirrors are updated
Code is included in next package
Docs are updated with minor release

42. Places to join thePlaces to join the
Postgres communityPostgres community
Slack
Local Meetups
PGConf NYC & pgDay Chicago
pgUS

43. Thank youThank you
very much!very much!
see you at the next meetup
sqlliz