Duplicated CONTRIBUTING.md

[scode2277]

What content are you looking to modify or update?

Currently, the repo has two CONTRIBUTING files:

• One at the root level (CONTRIBUTING.md), which GitHub renders in the repo’s landing page/dashboard
• One in docs/pages/contribute (contributing.mdx), which is rendered on the website

(screenshot of the dashboard attached below)

Why do you think this update or modification is needed?

This setup was a workaround since Vocs doesn’t render .md files, and GitHub doesn’t display .mdx files in the dashboard, but it’s not ideal — whenever one file is updated, we have to remember to update the other to keep them in sync.

Can you justify your argument and provide additional resources

• Root-level CONTRIBUTING.md: https://github.com/security-alliance/frameworks/blob/develop/CONTRIBUTING.md
• Website contributing.mdx: https://github.com/security-alliance/frameworks/blob/develop/docs/pages/contribute/contributing.mdx

The dashboard of which above:

[mattaereal]

If you manage to have two exact same files, symbolic linking might just work, have you tried it?

[mattaereal]

We're going to explore importing the content from CONTRIBUTING.md to avoid duplication and maintaining two files unnecessary.

[scode2277]

I tried using a symlink, but the two files aren’t exactly the same. The .mdx file has the frontmatter + imports and components (at the top, at the bottom and also in between), and the internal links need to be different — for example, to link to the Stewards file:

• for the root file it has to be: /docs/pages/contribute/stewards.mdx
• for the .mdx it has to be /contribute/stewards (otherwise the build fails for dead links)

For the same reason, trying to import just the content (like some sort of component) is tricky too.
In our case, what would solve the problem is a pre-build script that copies the content from the .mdx and removes/changes what needs to be changed, but i know you are not a fan ;)

I'm ofc open to other approaches to try and test :)

[mattaereal]

Yeah I don't like it haha, but go ahead with that and document it. Leave an issue to discuss a better alternative for this in the future