Developers Forum for XinFin XDC Network

AnilChinchawale
AnilChinchawale

Posted on

🔧 Scaling Open-Source Collaboration: XDC Network GitHub Code Contribution & Review Workflow

At the heart of any thriving open-source ecosystem lies a well-defined contribution workflow—one that promotes transparency, accountability, and high-quality code. To keep up with the growth of our developer community, we’re standardizing how code gets contributed, reviewed, and merged into our repositories.

Whether you’re a core contributor or just getting started, this guide outlines how we collaborate effectively on GitHub—and how that directly strengthens the XDC Network.


🚀 Step 1: Raise an Issue for Every Suggestion or Feature

All ideas begin with a conversation. That starts with a GitHub Issue.

  • 🛠 Found a bug?
  • 💡 Have a new feature in mind?
  • 🧩 Want to propose an optimization or refactor?

👉 Create an issue in the appropriate GitHub repository before writing any code.

This ensures:

  • Transparent discussion and feedback
  • Avoidance of duplicate efforts
  • Alignment with the broader XDC Network roadmap

Each pull request (PR) must reference the related issue using Closes #123 or Fixes #456.


👩‍💻 Step 2: Code Contribution Flow

Contributors

Anyone—including Amanda, Liu Dan, Nolan, Galaxy Tarun, and the wider community—can contribute using this workflow:

  1. Fork the repository and create a new branch from dev.
  2. Implement your changes (bug fix, feature, or enhancement).
  3. Write clear commit messages and follow code standards.
  4. Submit a PR to the dev branch with:
    • A link to the related issue
    • A clear summary of the change
    • Tags indicating if it’s a feature, fix, or breaking change

🚨 Breaking Changes

If your PR introduces breaking changes:

  • Add BREAKING CHANGE to the title and description
  • Provide documentation or migration instructions
  • Request explicit approval from Fisher

🔍 Step 3: Review & Approval

Reviewers

All PRs must be reviewed and approved by at least two of the following reviewers:

  • Liam
  • Wanwiset
  • AnilChinchawale

They will:

  • Review code quality and security
  • Validate against architectural guidelines
  • Approve when standards are met

No PR will be merged without 2 reviewer approvals.


⚙️ Step 4: Merge & Release

After review and approval:

  • The PR is merged into the dev branch.
  • Final merges into main happen via our release cycle and CI/CD.
  • All merges are traceable, auditable, and well-documented.

🌍 How This Supports the XDC Network

This workflow directly supports the growth, visibility, and reliability of the XDC Network:

  • 📈 Improves visibility of network development across the ecosystem
  • 🧠 Encourages innovation from contributors worldwide
  • 🔗 Builds trust with enterprises, node operators, and ecosystem partners
  • 📣 Signals transparency and openness to the global blockchain community

Every merged PR becomes public proof of collaboration, fostering community confidence and helping attract new talent, researchers, and integration partners.


💬 Summary

This workflow ensures:

  • High-quality, secure, and scalable code
  • Transparent contributor onboarding
  • Strict controls for breaking changes
  • Clear governance over core protocol development

🧠 Final Thoughts

Open-source is a team sport. With this workflow, we’re not just managing code—we’re building a movement.

If you're ready to contribute or just want to understand the process, open an issue and dive in. Together, we’ll continue to grow the XDC Network—securely, scalably, and openly.

Discussion (4)

Collapse
juklee0ira profile image
JukLee0ira

During the process, we can suggest that contributors add tests for larger or more important changes. It helps improve code quality, prevents regressions, and speeds up the review and merge process

Collapse
anilchinchawale profile image
AnilChinchawale Author

Totally agree with Dan and JukLee0ira! Suggesting tests for bigger changes in the PR process is spot on it'll boost code quality, catch regressions early, and make reviews smoother overall.

Collapse
gzliudan profile image
Daniel Liu

maybe we should update PR template: github.com/XinFinOrg/XDPoSChain/bl...