Skip to content

Comments

docs: fix Contributing.md outdated references#3807

Open
cluster2600 wants to merge 1 commit intofalcosecurity:masterfrom
cluster2600:docs/fix-contributing-md-references
Open

docs: fix Contributing.md outdated references#3807
cluster2600 wants to merge 1 commit intofalcosecurity:masterfrom
cluster2600:docs/fix-contributing-md-references

Conversation

@cluster2600
Copy link

Summary

Fixes three documentation bugs in Contributing.md that were carried over from the falcosecurity/libs repository (where this guide originated):

Changes

  1. Fix incorrect path reference: The Makefile section instructed contributors to run make format-all from (/libs), which is the falcosecurity/libs repository root, not this one. Changed to say "from the root directory of the project" to be repo-agnostic and accurate.

  2. Fix wrong repository name in DCO section: The DCO introduction said "Another requirement for contributing to the libs repository". This should reference the falco repository since the file lives here.

  3. Fix broken markdown link: The line referring to the DCO section used double parentheses [dedicated section]((#add-dco-signed-off-to-your-commits)), which causes the hyperlink to render incorrectly in most Markdown parsers. Corrected to use single parentheses.

Type of change

  • Documentation / Contributing guide fix

Signed-off-by: Maxime Grenu maxime.grenu@gmail.com

- Replace incorrect `/libs` path reference with 'the root directory
  of the project'; this file is for the falco repo, not falcosecurity/libs.
- Fix the DCO section: replace `libs` repository mention with `falco`
  so it accurately refers to this repository.
- Fix broken markdown hyperlink: `[dedicated section]((#anchor))` had
  double opening parentheses causing the link to render incorrectly;
  corrected to `[dedicated section](#anchor)`.

Signed-off-by: Maxime Grenu <maxime.grenu@gmail.com>
@poiana
Copy link
Contributor

poiana commented Feb 19, 2026

Adding the "do-not-merge/release-note-label-needed" label because no release-note block was detected, please follow our release note process to remove it.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@poiana
Copy link
Contributor

poiana commented Feb 19, 2026

Welcome @cluster2600! It looks like this is your first PR to falcosecurity/falco 🎉

@poiana poiana requested review from Kaizhe and irozzo-1A February 19, 2026 14:21
@poiana
Copy link
Contributor

poiana commented Feb 19, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: cluster2600
Once this PR has been reviewed and has the lgtm label, please assign mstemm for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@poiana poiana added the size/XS label Feb 19, 2026
@cluster2600
Copy link
Author

Hi team — could someone add the appropriate release-note label? The change is purely documentation (fixing outdated references in CONTRIBUTING.md), so release-note/none would be appropriate if that's available. Thanks!

@ekoops
Copy link
Contributor

ekoops commented Feb 20, 2026

Hi team — could someone add the appropriate release-note label? The change is purely documentation (fixing outdated references in CONTRIBUTING.md), so release-note/none would be appropriate if that's available. Thanks!

Hey, thank you for the contribution! Actually, the #add-dco-signed-off-to-your-commits anchor is still broken in both the link you adjusted and the other one (there is another pointing to the same section). Looks like the correct one is #add-dco-signed-off-to-your-commits- (notice the trailing -. Also, could you please bring back the original PR template? That is the reason why poiana is not able to correctly classify it and put the right labels.

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

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

3 participants