Skip to content

doc: fix outdated links in CONTRIBUTING.md#21824

Merged
crasbe merged 1 commit intoRIOT-OS:masterfrom
spnirmal:fix-contributing.md
Oct 29, 2025
Merged

doc: fix outdated links in CONTRIBUTING.md#21824
crasbe merged 1 commit intoRIOT-OS:masterfrom
spnirmal:fix-contributing.md

Conversation

@spnirmal
Copy link
Contributor

Contribution description

This PR updates outdated/deprecated links in CONTRIBUTING.md to ensure new contributors are redirected to the correct resources.

Changes made:

  • Updated old GitHub links pointing to deprecated documentation pages.
  • Replaced invalid GitHub URLs with current links.
  • Improved clarity of instructions by fixing formatting inconsistencies.

This improves documentation quality and reduces friction for new contributors.

Testing procedure

  1. Open the modified CONTRIBUTING.md file in the browser or markdown preview.
  2. Click on each link that was changed.
  3. Verify that all links correctly redirect to the intended, current documentation pages (no 404 / deprecated pages).

No code execution needed — documentation only.

Issues/PRs references

None.

@spnirmal spnirmal requested a review from jia200x as a code owner October 29, 2025 11:54
@github-actions github-actions bot added the Area: doc Area: Documentation label Oct 29, 2025
@crasbe crasbe added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs labels Oct 29, 2025
@crasbe crasbe requested a review from AnnsAnns October 29, 2025 11:58
CONTRIBUTING.md Outdated

[try-github-io]: https://try.github.io/
[git-scm-getting-started]: https://git-scm.com/book/en/v2/Getting-Started-Git-Basics
[git-scm-getting-started]: https://docs.github.com/en/get-started
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[git-scm-getting-started]: https://docs.github.com/en/get-started
[git-scm-getting-started]: https://git-scm.com/book/en/v2/Git-Basics-Getting-a-Git-Repository

This would probably be the fixed URL with the same resource as before. I think it might be better to discuss changing this to Github specific doc in a follow up PR and focus this on just fixing the broken links. That way, we can just merge this without having to discuss changes.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This got lost in the squash 👀

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This got lost in the squash 👀

thanks for pointing that out. i have restored the correct link thanks for guidance.

@riot-ci
Copy link

riot-ci commented Oct 29, 2025

Murdock results

✔️ PASSED

1a2b77d doc: fix outdated links in CONTRIBUTING.md

Success Failures Total Runtime
1 0 1 02m:48s

Artifacts

Copy link
Member

@AnnsAnns AnnsAnns left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the changes :) Please squash

@spnirmal spnirmal force-pushed the fix-contributing.md branch from 56d5d3d to 61e0ae6 Compare October 29, 2025 14:56
@github-actions github-actions bot added the Area: build system Area: Build system label Oct 29, 2025
@AnnsAnns
Copy link
Member

It looks like you accidentally included the commits that were merged as part of #21823 in your squashed commit

@spnirmal spnirmal force-pushed the fix-contributing.md branch from 61e0ae6 to 9bbde21 Compare October 29, 2025 15:10
@github-actions github-actions bot removed the Area: build system Area: Build system label Oct 29, 2025
@AnnsAnns
Copy link
Member

It looks like you accidentally removed the review change.

For future reference, because git can be confusing. You can use git rebase -i COMMIT_BEFORE_YOUR_PR and then change the pick to fixup on the commit you want to squash into the other commit. https://git-scm.com/docs/git-rebase#_interactive_mode

@spnirmal
Copy link
Contributor Author

the removal of review change was unintentional - it happened while squashing commits.i have now ensured that all relevant changes are included and only the intended modification remains in this PR.
going forward i will use git rebase -i as suggested.

@spnirmal spnirmal force-pushed the fix-contributing.md branch from 9bbde21 to 1a2b77d Compare October 29, 2025 15:58
@crasbe crasbe enabled auto-merge October 29, 2025 16:00
@crasbe crasbe added this pull request to the merge queue Oct 29, 2025
Merged via the queue into RIOT-OS:master with commit 9890215 Oct 29, 2025
27 checks passed
@crasbe
Copy link
Contributor

crasbe commented Oct 29, 2025

Thank you for your contribution! :)

Git and Github can be a steep learning curve indeed.

@benpicco benpicco added this to the Release 2025.10 milestone Dec 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants