Skip to content

Commit bf64351

Browse files
authored
docs: update instructions for contributing (#729)
* update docs * add checkbox to PR template
1 parent 4a259b4 commit bf64351

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

.github/pull_request_template.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,4 @@
3131
<!--- If you need clarification on any of these, feel free to ask. We're here to help! -->
3232
- [ ] I have updated [CHANGELOG.md](../CHANGELOG.md) to cover notable changes.
3333
- [ ] I have updated all related GitHub issues to reflect their current state.
34+
- [ ] I have run the `rsconnect-python-tests-at-night` workflow in Connect against this feature branch.

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,15 @@ uses some of these targets during the CI for building and testing.
5353
Any and all proposed changes are expected to be made via [pull
5454
request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests).
5555

56+
### Testing Against Connect
57+
58+
Prior to merging, we run tests against the dev version of Connect using the `rsconnect-python-tests-at-night` workflow
59+
in the Connect repository. To test a feature branch:
60+
61+
1. Navigate to the `rsconnect-python-tests-at-night` workflow in the Connect repository
62+
2. Trigger it manually via workflow_dispatch
63+
3. Specify your `rsconnect-python` branch/ref in the dropdown
64+
5665
## Versioning and Releasing
5766

5867
All version and release management is done via [annotated git tags](https://git-scm.com/docs/git-tag), as this is the

0 commit comments

Comments
 (0)