Add separate & improved how-to-contribute page - #210
Conversation
dalito
changed the title
6d1d7ca to
2da7a64
Compare
|
I moved the contribution guide out of the guidelines into the page https://nfdi4cat.github.io/voc4cat/docs_usage/how-to-contribute.html and extended it. At some point we may drop the Guidelines (V2.0) / All-in-one-page (as published) since it can slowly replaced by the update HTML-guidelines and the How-to-contribute guide in this PR. @nmoust - I merge this PR now. Since the changes are big you can better review of the rendered HTML page than the markdown with MyST markup formatting. |
github-project-automation
Bot
moved this from In progress
to Completed
in Voc4Cat cross-repo view
|
@dalito: Everything looks really nice! I would only add in the "Create the pull request" section, that if the user cannot see "base repository: nfdi4cat/voc4cat base: main" option they should click on the link above with the text: "compare across forks". This might be the case if the contributor checks the PR from their own fork. The "compare across forks" text is not visible in the screenshot. |
|
@nmoust thanks for the feedback. What you refer to, is a PR created from the "Pull Requests" tab? If the repo has differs from upstream it is possible to start the PR directly via the main "Code" tab (maybe this is not so clear?). |
|
From my fork of Voc4Cat (synched), when I submit an xlsx file in the inbox folder, and click "Propose changes" (screenshot 1), the next screen gives me the option to merge my "test-branch" to my main (screenshot 2). But if I click the "compare across forks" link, I get the option to merge my "test-branch" to the NFDI4Cat/Voc4Cat main (screenshot 3). 
|
|
I see. So it would be good to add a hint to click "compare across forks" if the user cannot select the upstream repo. |
* Improve how-to-contribute (styling and PR #210 follow-up) * Clean-up README - remove duplicate contributing guide * Make copilot PR reviews more precise & less noisy * Avoid PR-from-org-warning for home-organization and switch to using gh-markdown alert messages
* Improve how-to-contribute (styling and PR nfdi4cat#210 follow-up) * Clean-up README - remove duplicate contributing guide * Make copilot PR reviews more precise & less noisy * Avoid PR-from-org-warning for home-organization and switch to using gh-markdown alert messages
This pull request introduces several improvements to the documentation.
how-to-contribute.mdwith expanded step-by-step instructions, diagrams, and tabbed UI guidanceuvpackage manager instead ofpipsphinxcontrib-mermaidextension for diagram supportOpen ToDos:
Closes #152