Skip to content

Commit ae7db1e

Browse files
committed
DOC: Update PR template and CONTRIBUTING.md
1 parent 763a4e9 commit ae7db1e

File tree

3 files changed

+29
-5
lines changed

3 files changed

+29
-5
lines changed

.github/pull_request_template.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
# Pull Request
1+
# Pull request
22

33
Please include a summary of the changes.
4+
Please also include relevant motivation and context.
5+
List any dependencies that are required for this change.
6+
7+
Fixes # (issue)
48

59
## Type of change
610

@@ -13,4 +17,22 @@ Please delete options that are not relevant.
1317

1418
## How has this change been tested?
1519

16-
Please describe how this code was/is tested.
20+
Please describe the tests that you ran to verify your changes.
21+
Provide instructions so we can reproduce.
22+
Please also list any relevant details for your test configuration.
23+
24+
- [ ] Test A
25+
- [ ] Test B
26+
27+
## Checklist
28+
29+
- [ ] My code builds locally with no new warnings (`scripts/build.sh`)
30+
- [ ] My code follows the [style guidelines](https://google.github.io/styleguide/cppguide.html)
31+
- [ ] New and existing unit tests pass locally with my changes (`scripts/test.sh`)
32+
- [ ] I have made corresponding changes to the documentation
33+
- [ ] I have added tests that prove my fix is effective or that my feature works
34+
35+
## Declaration
36+
37+
I confirm this contribution is made under an Apache 2.0 license and that I have the authority
38+
necessary to make this contribution on behalf of its copyright owner.

.github/workflows/build.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ name: build
33
# Build and test databento-cpp
44

55
on:
6+
pull_request:
67
push:
78

89
jobs:

CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1-
We welcome feedback through discussions and issues on GitHub, however we don't currently accept pull requests due to the open-source repository being a downstream mirror of our internal codebase.
2-
3-
Please direct email feedback to support@databento.com or carter@databento.com.
1+
Thank you for taking the time to contribute to our project.
2+
We welcome feedback through discussions and issues on GitHub, as well as our [community Slack](https://databento.com/support).
3+
While we don't merge pull requests directly due to the open-source repository being a downstream
4+
mirror of our internal codebase, we can commit the changes upstream with the original author.

0 commit comments

Comments
 (0)