Broken Anchor Links and Section References in CONTRIBUTING.md

[vermarjun]

Bug Report 🐛

Broken Anchor Links and Section References in CONTRIBUTING.md

Related to #506

---

Expected Behavior

All internal links within CONTRIBUTING.md should successfully resolve to valid sections within CONTRIBUTING.md or DEVELOPERS.md.

---

Current Behavior

There are several broken anchor links in CONTRIBUTING.md that point to non-existent sections, leading to confusing 404-like behaviour within GitHub's markdown renderer. This appears to be boilerplate text copied from another project that wasn't fully adapted to techdocs.

Specifically:

1. Table of Contents:

• [Updating Documentation] resolves to #updating, which does not exist in the file.
• [Technical Documentation] resolves to #techdocs, which does not exist.

2. Pull Request Submission Guidelines:

• The text references checking the [Contributor License Agreement] (CLA), but Accord Project uses a Developer Certificate of Origin (DCO) instead. The link resolves to a non-existent #cla anchor.
• The pull request conventions link points to a missing [developers.pullrequest] reference instead of the local #submit-pr section.

3. References to DEVELOPERS.md:

• [developers.setup] links to DEVELOPERS.md#-development-setup, but the correct anchor is #installation.
• [developers.rules], [developers.documentation], and [developers.unit-tests] link to sections (#rules, #documentation, #-running-the-unit-test-suite) that do not exist in DEVELOPERS.md.

---

Steps to Reproduce

1. Go to the CONTRIBUTING.md file in the GitHub web interface.
2. In the Table of Contents, click "Updating Documentation" or "Technical Documentation".
3. Under the "Pull Request Submission Guidelines" section, try clicking the links for "development environment", "Coding Rules", "documentation", "unit test suite", or "Contributor License Agreement".
4. Observe that the page either does not scroll anywhere, or it navigates to the top of DEVELOPERS.md without finding the specified section.

---

Possible Solution

1. Remove the [Updating Documentation] and [Technical Documentation] items from the Table of Contents.
2. In the PR submission guidelines, change "Contributor License Agreement" to "Developer Certificate of Origin" and link to the existing [dcohow] reference.
3. Fix the [developers.setup] link to point to DEVELOPERS.md#installation.
4. Update the other broken [developers.*] references to simply link to DEVELOPERS.md, as there are no distinct sections for those topics in the document yet.
5. Fix the missing [developers.pullrequest] linkage by pointing to the [contribute.submitpr] reference.

---

Possible Implementation

I have already investigated the broken links and have a clear plan to resolve them by modifying the markdown references at the bottom of the document and updating the specific lines. I would be happy to submit a Pull Request to fix this issue!

[vermarjun]

@mttrbrts @sanketshevkar can you please look at this issue I found, please check out the "Steps to Reproduce" section to quickly verify the issue. I would like to work on the issue, please lmk once confirmed.