docs(contributing): add docs-build, testing conf, & build instructions #787
Conversation
This file contains 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
codejedi365
force-pushed
the
docs/contributing
branch
from
fc864c8
to
a5c648b
Compare
codejedi365
force-pushed
the
docs/contributing
branch
from
a5c648b
to
f9320a9
Compare
bernardcooke53
merged commit 011b072
into
python-semantic-release:master
8 checks passed
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.
Purpose
Add additional testing and development instructions for an contributing developer
Rationale
I was unfamiliar with the some of tools and the configuration of this project. This adjustment helps other developers not have to figure it out but instead have the commands on hand to know what to do.
How I tested
I manually executed all the new instructions added here during my development. I ran a VSCode debugger on a pytest function and was able to break at a desired breakpoint in the test and in the code. For the docs, the
_buildwas important for thesphinx-autobuildwatchdog server to not trigger a rebuild on the creation of the docs initially.