-
Notifications
You must be signed in to change notification settings - Fork 95
Docs: restructure contributing guide and add community cards #764
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
base: main
Are you sure you want to change the base?
Docs: restructure contributing guide and add community cards #764
Conversation
|
Thanks for opening the PR, @ishan372or ! Just a heads-up that the current CI failures are unrelated to your changes. You can fix them by fetching updates from the main branch. You can either:
Once that’s done, the CI should pass again (or fail for reasons related to your PR). |
bf3dfe0 to
ff7423f
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #764 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 34 34
Lines 2111 2111
=========================================
Hits 2111 2111 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
@niksirbi , The sphinx linkcheck error is caused by an external link |
|
@ishan372or you are right about it being unrelated. I just checked that link and it seems that particular standard has been withdrawn and replaced with https://www.iso.org/standard/82075.html. Let's try this new link, and if that also returns a 403 error, you may add it to the |
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.
Hey @ishan372or, this is in the right direction, but will need more work (see my comments below for detailed instructions).
- Added a "Quickstart" guide for experienced developers.
This seems to be missing. Anyhow, I think that's of secondary priority, and can be also added later. For now please focus on addressing my comments.
|
@niksirbi, Thanks for the detailed review. Will start making changes based on suggestions and push commits as i go. |
|
Thanks @ishan372or. Please make sure to merge the latest changes from |
9bb9759 to
78bbb91
Compare
|
|
@niksirbi The CI failure appears unrelated to this PR. The tests fail due to a timeout while downloading sample data from gin.g-node.org during pytest_sessionstart, resulting in a ConnectTimeoutError. Could you please take a look |



Description
What is this PR
Why is this PR needed?
This PR addresses issue #664. The previous contributing guidelines lacked explicit instructions on the "fork and pull request" workflow, which could be confusing for first-time contributors. Additionally, the Community documentation page was a simple list of links, which could be improved for better navigation and user experience.
What does this PR do?
Restructures CONTRIBUTING.md:
- Added a "Quickstart" guide for experienced developers.
- Moved the "Forking the repository" instructions to a dedicated section at the top.
- Clarified the Pull Request workflow, specifically distinguishing between pushing to a user's fork (origin) and syncing with the main repo (upstream).
Updates Community Docs:
-Converted the list of links in docs/source/community/index.md into a responsive card layout (Grid) using sphinx-design to match the style of the User Guide.
References
fixes #664
How has this PR been tested?
I have built the documentation locally using sphinx-build and verified that.
Is this a breaking change?
No.
Does this PR require an update to the documentation?
Yes, this PR is exclusively an update to the documentation.
Checklist: