Skip to content

Conversation

Mayankm96
Copy link
Contributor

@Mayankm96 Mayankm96 commented Sep 9, 2025

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

  • I have run the pre-commit checks with ./isaaclab.sh --format
  • I have made corresponding changes to the documentation
  • 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
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

@Mayankm96 Mayankm96 requested review from Copilot and kellyguo11 and removed request for kellyguo11, hhansen-bdai and jtigue-bdai September 9, 2025 12:15
@Mayankm96 Mayankm96 added the documentation Improvements or additions to documentation label Sep 9, 2025
@Mayankm96 Mayankm96 requested a review from ooctipus September 9, 2025 12:15
Copy link
Contributor

@Copilot Copilot AI left a 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.

Mayankm96 and others added 2 commits September 9, 2025 17:30
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]>
@Mayankm96 Mayankm96 merged commit 8172390 into isaac-sim:main Sep 10, 2025
4 of 5 checks passed
ooctipus pushed a commit to ooctipus/IsaacLab that referenced this pull request Sep 20, 2025
# 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants