|
| 1 | +<!-- |
| 2 | + Copyright (c) 2025 ADBC Drivers Contributors |
| 3 | +
|
| 4 | + Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + you may not use this file except in compliance with the License. |
| 6 | + You may obtain a copy of the License at |
| 7 | +
|
| 8 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +
|
| 10 | + Unless required by applicable law or agreed to in writing, software |
| 11 | + distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + See the License for the specific language governing permissions and |
| 14 | + limitations under the License. |
| 15 | +--> |
| 16 | + |
| 17 | +# How to Contribute |
| 18 | + |
| 19 | +## Reporting Issues |
| 20 | + |
| 21 | +Please file issues on the GitHub issue tracker: |
| 22 | +https://github.com/adbc-drivers/validation/issues |
| 23 | + |
| 24 | +Potential security vulnerabilities should be reported to |
| 25 | +[security@adbc-drivers.org](mailto:security@adbc-drivers.org) instead. See |
| 26 | +[SECURITY.md](./SECURITY.md). |
| 27 | + |
| 28 | +## Opening a Pull Request |
| 29 | + |
| 30 | +Before opening a pull request: |
| 31 | + |
| 32 | +- Review your changes and make sure no stray files, etc. are included. |
| 33 | +- Ensure the Apache license header is at the top of all files. |
| 34 | +- Check if there is an existing issue. If not, please file one, unless the |
| 35 | + change is trivial. |
| 36 | +- Assign the issue to yourself by commenting just the word `take`. |
| 37 | +- Run the static checks by installing [pre-commit](https://pre-commit.com/), |
| 38 | + then running `pre-commit run --all-files` from inside the repository. Make |
| 39 | + sure all your changes are staged/committed (unstaged changes will be |
| 40 | + ignored). |
| 41 | + |
| 42 | +When writing the pull request description: |
| 43 | + |
| 44 | +- Ensure the title follows [Conventional |
| 45 | + Commits](https://www.conventionalcommits.org/en/v1.0.0/) format. No |
| 46 | + component is necessary. Example titles: |
| 47 | + - `feat: test ingestion with target schema` |
| 48 | + - `fix: don't assume SQLSTATE values` |
| 49 | + - `feat!: test multiple types in one query` |
| 50 | + |
| 51 | + Ensure that breaking changes are appropriately flagged with a `!` as seen |
| 52 | + above. |
| 53 | +- Make sure the bottom of the description has `Closes #NNN`, `Fixes #NNN`, or |
| 54 | + similar, so that the issue will be linked to your pull request. |
0 commit comments