PYTHON-5343 Clean up contributing docs #2390
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
blink1073
commented
Jun 16, 2025
blink1073
commented
- Moves the SSL considerations from the Team Practices document to the contributing guide
- Cleans up the instructions for starting a server
- Specifies that secrets are only required for certain tests
NoahStapp
requested changes
Jun 16, 2025
CONTRIBUTING.md
Outdated
| - Run `just install` to set a local virtual environment, or you can manually | ||
| create a virtual environment and run `pytest` directly. If you want to use a specific | ||
| version of Python, remove the `.venv` folder and set `PYTHON_BINARY` before running `just install`. | ||
| - Ensure you have started the appropriate Mongo Server(s). You can run `just run-server` with optional args | ||
| to set up the server. All given options will be passed to | ||
| `run-orchestration.sh` in `$DRIVERS_TOOLS`. See `$DRIVERS_TOOLS/evergreen/run-orchestration.sh -h` |
There was a problem hiding this comment.
$DRIVERS_TOOLS/evergreen/run-orchestration.sh -h should be a link to the actual file in drivers-evergreen-tools.
| ### SSL tests | ||
|
|
||
| - Run `just run-server --ssl` to start the server with TLS enabled. | ||
| - Run `just setup-tests --ssl`. |
There was a problem hiding this comment.
This line is just a repeat of the previous one.
There was a problem hiding this comment.
No, they use different targets
CONTRIBUTING.md
Outdated
| - Run `just setup-tests --ssl`. | ||
| - Run `just run-tests` | ||
|
|
||
| Note: for general testing purposes with an TLS-enabled server, you can use the following: |
There was a problem hiding this comment.
I'd call out that this is for testing ONLY, and should never be used in a non-testing context.
NoahStapp
approved these changes
Jun 16, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.