Add a typical workflow to CONTRIBUTING #72
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
Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive onboarding documentation to CONTRIBUTING.md, providing new contributors with detailed setup instructions and a typical development workflow. The changes are adapted from the ni-apis-python repository and tailored for the datastore-python project.
- Adds prerequisites section with installation links for required tools
- Introduces a "Simple Development Loop" section with step-by-step commands
- Improves clarity in existing Testing and Publishing sections
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
dixonjoel
approved these changes
Nov 18, 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.
What does this Pull Request accomplish?
This PR brings over some onboarding info from ni-apis-python (original) and tailors it for this repo.
Why should this Pull Request be merged?
Helps onboard new contributors.
What testing has been done?
Validated the recommended commands in the text.