-
Notifications
You must be signed in to change notification settings - Fork 3
docs: contribution guide to docs #23
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 significantly enhances the contributing documentation by transforming it from a basic guide into a comprehensive, step-by-step tutorial for new contributors. The changes include:
- A detailed walkthrough covering prerequisites, forking, cloning, editing, and submitting pull requests
- Four new screenshot images to help visualize the GitHub workflow
- Additional information about text editors and development setup
- Adding
.DS_Storeto.gitignoreto prevent macOS system files from being tracked
Reviewed Changes
Copilot reviewed 1 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/en/contributing/contributing-to-docs.md | Complete rewrite with step-by-step instructions, expanded from 28 to 256 lines with detailed guidance for new contributors |
| docs/en/contributing/img/python-windows-path.png | Screenshot showing Python installation PATH option for Windows users |
| docs/en/contributing/img/github-fork.png | Screenshot illustrating the GitHub fork button location |
| docs/en/contributing/img/github-pull-requests.png | Screenshot showing the GitHub Pull Requests tab |
| docs/en/contributing/img/github-clone.png | Screenshot showing how to copy the clone URL from GitHub |
| .gitignore | Added .DS_Store to ignore macOS system files |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
LordIdra
left a comment
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.
Thanks for the PR and apologies it took so long to review
|
Happy with this now, thanks for this 👍 |
Rewrote the docs contribution page to a step-by-step guide.