-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Revamped docs for easier contributing. #123
base: mainline
Are you sure you want to change the base?
Conversation
Signed-off-by: Eric Osiowy <[email protected]>
26196c7
to
b4324ca
Compare
Quality Gate passedIssues Measures |
* Windows: `%USERPROFILE%\DeadlineCloud\Blender\python` | ||
* Linux/macOS: `~/DeadlineCloud/Blender/python` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this is specifically for developement and not a generic install, does this not have to be the location of the git repo location? The instructions don't tell you to run hatch build -> and pip install the whl. But they also don't point to the addon source directory. Looks like this was deleted from the previous instructions:
1. Install addon in Blender
- run `hatch build` in your local git repository
- `cp -r src/deadline/blender_submitter/addons/ ~/DeadlineCloudSubmitter/Submitters/Blender/python/addons`
Also, if they make changes, will they have to run commands to get their changes to show? We should include that in the workflow instructions.
We may need a separate section for manual installing for using, not for developing. ie. pip install from pypi, don't need clone of github, etc.
What was the problem/requirement? (What/Why)
The contributing and development guidelines in this repository could benefit from an improvement pass to make workflows, expectations, and intentions clearer.
What was the solution? (How)
Improvements are largely based off of changes in this PR.
Rework/refactor the CONTRIBUTING.md, DEVELOPMENT.md, README.md, GitHub issue templates, pull request template and software arch doc with the goal of improving understandability to those not familiar with the code base, hatch-based workflows, GitHub pull request workflows, and our use of conventional commits.
What is the impact of this change?
This should ease the on-boarding to the development process and allow others to better understand the package.
How was this change tested?
I ran through the setup with Blender to make sure they were correct.
Was this change documented?
N/A
Is this a breaking change?
No.