docs: fix Contributing.md outdated references#3807
docs: fix Contributing.md outdated references#3807cluster2600 wants to merge 1 commit intofalcosecurity:masterfrom
Conversation
- 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>
|
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. DetailsInstructions 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. |
|
Welcome @cluster2600! It looks like this is your first PR to falcosecurity/falco 🎉 |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: cluster2600 The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Hi team — could someone add the appropriate release-note label? The change is purely documentation (fixing outdated references in CONTRIBUTING.md), so |
Hey, thank you for the contribution! Actually, the |
Summary
Fixes three documentation bugs in
Contributing.mdthat were carried over from thefalcosecurity/libsrepository (where this guide originated):Changes
Fix incorrect path reference: The Makefile section instructed contributors to run
make format-allfrom(/libs), which is thefalcosecurity/libsrepository root, not this one. Changed to say "from the root directory of the project" to be repo-agnostic and accurate.Fix wrong repository name in DCO section: The DCO introduction said "Another requirement for contributing to the
libsrepository". This should reference thefalcorepository since the file lives here.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
Signed-off-by: Maxime Grenu maxime.grenu@gmail.com