-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Improves contribution guidelines for IsaacLab #3403
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
Conversation
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.
Pull Request Overview
This PR improves the contribution guidelines for IsaacLab by expanding documentation on code style, testing practices, and development workflows to help developers follow consistent patterns.
- Adds comprehensive code structure guidelines with examples showing proper organization of Python files and classes
- Expands unit testing documentation with platform-specific command examples for running tests
- Enhances the pull request template with clearer guidance on PR size and type descriptions
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
File | Description |
---|---|
docs/source/refs/snippets/code_skeleton.py | New example file demonstrating proper Python code structure and organization patterns |
docs/source/refs/contributing.rst | Major expansion of coding style guidelines, test running instructions, and code organization standards |
docs/source/overview/environments.rst | Cleanup of duplicate image and link references |
docs/conf.py | Minor documentation configuration updates |
.github/PULL_REQUEST_TEMPLATE.md | Improved PR template with clearer guidance and descriptions |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: James Tigue <[email protected]> Signed-off-by: Mayank Mittal <[email protected]>
Co-authored-by: James Tigue <[email protected]> Signed-off-by: Mayank Mittal <[email protected]>
Signed-off-by: Mayank Mittal <[email protected]>
# Description I realized there were some comments I often have to repeat in my reviewing process. I tried to add some of them into the code style page to directly point developers to it. ## Type of change - This change requires a documentation update ## Checklist - [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have updated the changelog and the corresponding version in the extension's `config/extension.toml` file - [x] I have added my name to the `CONTRIBUTORS.md` or my name already exists there --------- Signed-off-by: Mayank Mittal <[email protected]> Co-authored-by: James Tigue <[email protected]>
Description
I realized there were some comments I often have to repeat in my reviewing process. I tried to add some of them into the code style page to directly point developers to it.
Type of change
Checklist
pre-commit
checks with./isaaclab.sh --format
config/extension.toml
fileCONTRIBUTORS.md
or my name already exists there