Skip to content

Commit 8a88b30

Browse files
committed
DOC: Update PR template and CONTRIBUTING.md
1 parent ac23d31 commit 8a88b30

File tree

3 files changed

+21
-12
lines changed

3 files changed

+21
-12
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
## Description
22

3-
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
3+
Please include a summary of the change and which issue is fixed.
4+
Please also include relevant motivation and context.
5+
List any dependencies that are required for this change.
46

57
Fixes # (issue)
68

@@ -13,18 +15,24 @@ Please delete options that are not relevant.
1315
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
1416
- [ ] This change requires a documentation update
1517

16-
### How Has This Been Tested?
18+
### How has this been tested?
1719

18-
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
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.
1923

2024
- [ ] Test A
2125
- [ ] Test B
2226

27+
## Checklist
2328

24-
### Checklist:
25-
26-
- [ ] My code follows the style guidelines of this project
29+
- [ ] My code builds locally with no new warnings (`scripts/build.sh`)
30+
- [ ] My code follows the style guidelines (`scripts/lint.sh`)
31+
- [ ] New and existing unit tests pass locally with my changes (`scripts/test.sh`)
2732
- [ ] I have made corresponding changes to the documentation
28-
- [ ] My changes generate no new warnings
2933
- [ ] I have added tests that prove my fix is effective or that my feature works
30-
- [ ] New and existing unit tests pass locally with my changes
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/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
name: test
22

33
on:
4+
pull_request:
45
push:
5-
branches: [main, dev]
66

77
jobs:
88
test:

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-soruce repository being a downstream mirror of our internal Python client library codebase.
2-
3-
Please direct email feedback to [email protected] or [email protected].
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)