|
| 1 | +<!-- |
| 2 | +Please follow our code of conduct when engaging in the Beman community: |
| 3 | +https://github.com/bemanproject/beman/blob/main/docs/CODE_OF_CONDUCT.md |
| 4 | +--> |
| 5 | + |
| 6 | +<!-- |
| 7 | +Thank you for your contribution! |
| 8 | +
|
| 9 | +If you are updating project structure or build configs: |
| 10 | +- Make sure your contribution conforms to the Beman Standard: |
| 11 | + https://github.com/bemanproject/beman/blob/main/docs/BEMAN_STANDARD.md |
| 12 | +- For new CMake arguments / presets: please make sure you added appropriate CI tests. |
| 13 | +
|
| 14 | +If you are updating documentation: |
| 15 | +- Make sure badges and pictures does not impact readability. |
| 16 | +
|
| 17 | +If you are updating implementations: |
| 18 | +- Make sure you submit appropriate testing. |
| 19 | +
|
| 20 | +We encourage small and incremental additions instead of large redesigns. |
| 21 | +They are easier and faster to review. |
| 22 | +They are also less likely to introduce bugs. |
| 23 | +
|
| 24 | +While we do not formally adopt this guide as a standard, |
| 25 | +we encourage you to read and consider: |
| 26 | +"The CL author’s guide to getting through code review". |
| 27 | +https://google.github.io/eng-practices/review/developer/ |
| 28 | +
|
| 29 | +Regardless, feel free to open a PR on your existing changes. |
| 30 | +We appreciate the suggestion and will help out. |
| 31 | +
|
| 32 | +Please run pre-commit against your change to comply with our linting rules. |
| 33 | +The command to check all files in the directory is: |
| 34 | +$ pre-commit run --all-files |
| 35 | +--> |
| 36 | + |
| 37 | +<!-- markdownlint-disable-next-line MD041 --> |
| 38 | +## Description |
| 39 | + |
| 40 | +Please describe your contribution in a single sentence. |
| 41 | + |
| 42 | +## Related Issues |
| 43 | + |
| 44 | +<!-- use magic keywords like "fix" to close issues linked to this PR automatically --> |
| 45 | + |
| 46 | +## Motivation and Context |
| 47 | + |
| 48 | +Explain why this change is needed. |
| 49 | + |
| 50 | +## Testing |
| 51 | + |
| 52 | +Explain how is this tested. |
| 53 | + |
| 54 | +## Meta |
| 55 | + |
| 56 | +<!-- |
| 57 | +The convention in Beman is for the PR author to merge the PR once it's ready. |
| 58 | +You can check this box to indicate that you would like Beman members to merge the PR |
| 59 | +for you when appropriate reviews have passed. |
| 60 | +
|
| 61 | +Please note that: |
| 62 | +1. Stale PR may still be merged by a Beman member, |
| 63 | +if you need significant time to work on your PR, |
| 64 | +leave a comment and change it's status to draft. |
| 65 | +2. If you are not a member of the Beman project, |
| 66 | +you may not have the permission necessary to merge your own PR. |
| 67 | +--> |
| 68 | + |
| 69 | +- [ ] If all approvals are obtained and the PR is green, any Beman member can merge the PR. |
| 70 | + |
| 71 | +<!-- make sure you run pre-commit before opening a PR --> |
0 commit comments