Skip to content

hypha-dao/hypha-contributing

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 

Repository files navigation

HyphaPlatform Contribution

Managing contributions from remote contributors in a decentralized way to the hypha-web repository (or any open-source project) requires a combination of clear guidelines, automation, and community trust.

Here’s a structured approach:


1. Define Contribution Guidelines

Create a CONTRIBUTING.md file in the repo outlining:

  • How to fork & clone the repo
  • Branch naming conventions (e.g., feat/new-component, fix/login-bug)
  • Commit message style (e.g., Conventional Commits)
  • Testing requirements (if applicable)
  • Code review expectations

Example:

## How to Contribute  
1. Fork this repository  
2. Create a branch: `git checkout -b feat/your-feature`  
3. Commit changes (`git commit -m "feat: add new button component"`)  
4. Push to your fork (`git push origin feat/your-feature`)  
5. Open a **Pull Request** (PR) with a clear description.  

2. Use GitHub’s Fork & Pull Request Workflow

  • Contributors fork the repo and work on their own copy.
  • They submit changes via Pull Requests (PRs) to the main repo.
  • Maintainers review and merge PRs after approval.

Pros:
✅ Decentralized (no direct push access required)
✅ Built-in code review via GitHub


3. Automate Checks with GitHub Actions

Add workflows to automate:

  • Tests (run on PRs)
  • Linting (e.g., ESLint, Prettier)
  • Preview Deployments (e.g., Vercel/Netlify for web projects)

Example workflow file (.github/workflows/test.yml):

name: CI Tests  
on: [pull_request]  
jobs:  
  test:  
    runs-on: ubuntu-latest  
    steps:  
      - uses: actions/checkout@v4  
      - run: npm install  
      - run: npm test  

4. Use Issue Templates & Discussions

  • ISSUE_TEMPLATE.md helps contributors report bugs/features consistently.
  • GitHub Discussions for async collaboration (Q&A, ideas).

5. Decentralize Review with CODEOWNERS

Define CODEOWNERS (.github/CODEOWNERS) to auto-assign reviewers:

# Assign multiple reviewers per directory  
/frontend/  @user1 @user2  
/contracts/ @user3  

6. Consider a DAO-like Governance Model (Optional)

Since Hypha is DAO-related, you could:

  • Use Snapshot for off-chain voting on major changes.
  • Allow token-weighted PR approvals (experimental, via bots like OpenZeppelin’s Defender).

7. Monitor Activity with Bots

  • Dependabot (for dependency updates)
  • Welcome Bot (greets new contributors)
  • Stale Bot (closes inactive PRs/issues)

Key Tools Summary

Purpose Tool/Feature
Code Review GitHub PRs + CODEOWNERS
Automation GitHub Actions
Governance Discussions, Snapshot
Contributor UX CONTRIBUTING.md, Templates

Final Tip

For true decentralization, avoid granting direct push access—rely on forks + PRs. Over time, trusted contributors can earn maintainer roles.

About

A decentralized workflow for contributors to push changes to an open source repository

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published