Skip to content

Improve local development setup documentation - #8019

Open
Sureshpro171005 wants to merge 3 commits into
jupyter:mainfrom
Sureshpro171005:docs/dev-setup-improvements
Open

Improve local development setup documentation#8019
Sureshpro171005 wants to merge 3 commits into
jupyter:mainfrom
Sureshpro171005:docs/dev-setup-improvements

Conversation

@Sureshpro171005

Copy link
Copy Markdown

References

Addresses #7701

Summary

This PR improves the local development setup documentation in CONTRIBUTING.md by:

  • Adding a Prerequisites section with recommended Python and Node.js versions.
  • Adding guidance for a live-reloading development workflow using jlpm watch.
  • Improving the organization and readability of the development setup instructions.
  • Providing additional guidance to help first-time contributors set up the project.

Motivation

The current development setup documentation can be difficult for new contributors to follow. These documentation improvements aim to make the setup process clearer and easier to understand.

Testing

  • Reviewed the documentation for clarity and consistency.
  • Verified that the Markdown formatting renders correctly.

Checklist

  • I have read the contributing guidelines.
  • My changes are documentation only.

@Sureshpro171005

Copy link
Copy Markdown
Author

Hi maintainers, just following up on this PR when you get a chance. I’d be happy to make any changes or address any feedback. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant