Skip to content

Conversation

@AdekunleBamz
Copy link

Summary

Adds a dedicated "Contributing" section to the README.md that links to the detailed CONTRIBUTING.md guide and provides community links.

Problem

The README.md lacked a prominent "Contributing" section, making it harder for potential contributors to find contribution guidelines.

Solution

Added a clear Contributing section before the Copyright section, following the pattern of other open-source projects.

Testing

  • Verified the link to CONTRIBUTING.md works
  • Confirmed Discord link matches existing badge
  • Checked formatting consistency with rest of README

Add a dedicated Contributing section to the README.md that links to the detailed CONTRIBUTING.md guide and provides information about joining the community. This makes it easier for potential contributors to find contribution guidelines.
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


SmartFlow Developer seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

Add comprehensive module-level documentation to the Nakamoto relayer module explaining its purpose, key responsibilities, architecture, and integration points within the Stacks blockchain system.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants