|
| 1 | +# Contributing guide |
| 2 | + |
| 3 | +Welcome to `pg_tde` - the Transparent Database Encryption for PostgreSQL! |
| 4 | + |
| 5 | +We're glad that you would like to become a Percona community member and participate in keeping open source open. |
| 6 | + |
| 7 | +You can contribute in one of the following ways: |
| 8 | + |
| 9 | +1. Reach us on our [Forums](https://forums.percona.com/c/postgresql/pg-tde-transparent-data-encryption-tde/82). |
| 10 | +2. [Submit a bug report or a feature request](#submit-a-bug-report-or-a-feature-request) |
| 11 | +3. [Submit a pull request (PR) with the code patch](#submit-a-pull-request) |
| 12 | +4. [Contribute to documentation](#contributing-to-documentation) |
| 13 | + |
| 14 | +By contributing, you agree to the [Percona Community code of conduct](https://github.com/percona/community/blob/main/content/contribute/coc.md). |
| 15 | + |
| 16 | + |
| 17 | +## Submit a bug report or a feature request |
| 18 | + |
| 19 | +All bug reports, enhancements and feature requests are tracked in [Jira issue tracker](https://jira.percona.com/projects/PG). If you would like to suggest a new feature / an improvement or you found a bug in `pg_tde`, please submit the report to the [PG project](https://jira.percona.com/projects/PG/issues). |
| 20 | + |
| 21 | +Start by searching the open tickets for a similar report. If you find that someone else has already reported your issue, then you can upvote that report to increase its visibility. |
| 22 | + |
| 23 | +If there is no existing report, submit your report following these steps: |
| 24 | + |
| 25 | +1. Sign in to [Jira issue tracker](https://jira.percona.com/projects/PG/issues). You will need to create an account if you do not have one. |
| 26 | +2. In the _Summary_, _Description_, _Steps To Reproduce_, _Affects Version_ fields describe the problem you have detected or an idea that you have for a new feature or improvement. |
| 27 | +3. As a general rule of thumb, try to create bug reports that are: |
| 28 | + |
| 29 | + * Reproducible: describe the steps to reproduce the problem. |
| 30 | + * Unique: check if there already exists a JIRA ticket to describe the problem. |
| 31 | + * Scoped to a Single Bug: only report one bug in one JIRA ticket |
| 32 | + |
| 33 | +## Submit a pull request |
| 34 | + |
| 35 | +Though not mandatory, we encourage you to first check for a bug report among Jira issues and in the PR list: perhaps the bug has already been addressed. |
| 36 | + |
| 37 | +For feature requests and enhancements, we do ask you to create a Jira issue, describe your idea and discuss the design with us. This way we align your ideas with our vision for the product development. |
| 38 | + |
| 39 | +If the bug hasn’t been reported / addressed, or we’ve agreed on the enhancement implementation with you, do the following: |
| 40 | + |
| 41 | +1. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) this repository |
| 42 | +2. Clone this repository on your machine. |
| 43 | +3. Create a separate branch for your changes. If you work on a Jira issue, please include the issue number in the branch name so it reads as `<JIRAISSUE>-my_branch`. This makes it easier to track your contribution. |
| 44 | +4. Make your changes. Please follow the guidelines outlined in the [PostgreSQL Coding Standard](https://www.postgresql.org/docs/current/source.html) to improve code readability. |
| 45 | + <details> |
| 46 | + <summary>.vimrc configuration example</summary> |
| 47 | + |
| 48 | + ``` |
| 49 | + set nocompatible " choose no compatibility with legacy vi |
| 50 | + syntax enableset |
| 51 | + tabstop=4set |
| 52 | + background=lightset |
| 53 | + textwidth=80set |
| 54 | + colorcolumn=80 |
| 55 | + let g:filestyle_ignore_patterns = ['^\t* \{1,3}\S'] |
| 56 | + highlight Normal ctermbg=15 |
| 57 | + highlight ColorColumn ctermbg=52 |
| 58 | + ``` |
| 59 | + </details> |
| 60 | +
|
| 61 | +5. Test your changes locally. See the [Running tests ](#running-tests) section for more information |
| 62 | +6. Update the documentation describing your changes. See the [Contributing to documentation](#contributing-to-documentation) section for details |
| 63 | +7. Commit the changes. Add the Jira issue number at the beginning of your message subject, so that is reads as `<JIRAISSUE> : My commit message`. Follow this pattern for your commits: |
| 64 | +
|
| 65 | + ``` |
| 66 | + PG-1234: Main commit message. |
| 67 | + <Blank line> |
| 68 | + Details of fix. |
| 69 | + ``` |
| 70 | +
|
| 71 | + The [commit message guidelines](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53) will help you with writing great commit messages |
| 72 | +
|
| 73 | +8. Open a pull request to Percona |
| 74 | +9. Our team will review your code and if everything is correct, will merge it. Otherwise, we will contact you for additional information or with the request to make changes. |
| 75 | +
|
| 76 | +### Building pg_tde |
| 77 | +
|
| 78 | +To build `pg_tde` from source code, you require the following: |
| 79 | +
|
| 80 | +* git |
| 81 | +* make |
| 82 | +* gcc |
| 83 | +* pg_config |
| 84 | +
|
| 85 | +Refer to the [Building from source code](https://github.com/percona/pg_tde?tab=readme-ov-file#building-from-sources-for-community-postgresql) section for guidelines. |
| 86 | +
|
| 87 | +
|
| 88 | +### Running tests |
| 89 | +
|
| 90 | +When you work, you should periodically run tests to check that your changes don’t break existing code. |
| 91 | +
|
| 92 | +You can find the tests in the `sql` directory. |
| 93 | +
|
| 94 | +#### Run manually |
| 95 | +
|
| 96 | +1. Change directory to pg_tde |
| 97 | +
|
| 98 | +**NOTE**: Make sure `postgres` user is the owner of the `pg_tde` directory |
| 99 | +
|
| 100 | +2. Start the tests |
| 101 | + 1. If you built PostgreSQL from PGDG, use the following command: |
| 102 | +
|
| 103 | + ```sh |
| 104 | + make installcheck |
| 105 | + ``` |
| 106 | + |
| 107 | +
|
| 108 | + 2. If you installed PostgreSQL server from Percona Distribution for PostgreSQL, use the following command: |
| 109 | +
|
| 110 | + ```sh |
| 111 | + sudo su postgres bash -c 'make installcheck USE_PGXS=1' |
| 112 | + ``` |
| 113 | +#### Run automatically |
| 114 | +
|
| 115 | +The tests are run automatically with GitHub actions once you commit and push your changes. Make sure all tests are successfully passed before you proceed. |
| 116 | +
|
| 117 | +
|
| 118 | +## Contributing to documentation |
| 119 | +
|
| 120 | +`pg_tde` documentation is maintained in the `documentation` directory. Please read the [Contributing guide](https://github.com/percona/pg_tde/blob/main/documentation/CONTRIBUTING.md) for guidelines how you can contribute to the docs. |
| 121 | +
|
| 122 | +## After your pull request is merged |
| 123 | +
|
| 124 | +Once your pull request is merged, you are an official Percona Community Contributor. Welcome to the community! |
0 commit comments