Back to Nofx

πŸ‘₯ NOFX Community

docs/community/README.md

latest6.8 KB
Original Source

πŸ‘₯ NOFX Community

Welcome to the NOFX community! This section contains everything you need to contribute and participate.


πŸ“’ Important Announcement

πŸš€ New PR Management System Coming Soon!

We're introducing a new PR management system to improve code quality and make contributing easier!

πŸ“– Read: Migration Announcement | θΏη§»ε…¬ε‘ŠοΌˆδΈ­ζ–‡οΌ‰

Timeline: 4-week gradual rollout starting soon

For existing PRs: Don't worry! Your PRs will not be blocked by new rules.


🀝 How to Contribute

Getting Started

  1. Read the Guides

  2. Find Something to Work On

  3. Join the Community


πŸ’° Bounty Program

Active Bounties

NOFX offers bounties for valuable contributions:

CategoryReward RangeExamples
πŸ₯‡ Major Features$500-1000Exchange integration, core architecture
πŸ₯ˆ Medium Features$200-500WebSocket support, new AI models
πŸ₯‰ Small Features$50-200Bug fixes, UI improvements, documentation

How to Claim Bounties

πŸ“– Complete Guide: bounty-guide.md

Quick Steps:

  1. Find issue tagged [BOUNTY]
  2. Comment with your proposal
  3. Wait for approval
  4. Work on the task
  5. Submit PR with demo
  6. Get paid after merge!

Current Bounty Tasks

TaskRewardDifficultyStatus
Hyperliquid IntegrationTBDHard🟑 Open
Aster DEX IntegrationTBDMediumβœ… Completed

πŸ† Recognition

Ways to Get Recognized

Contributor Levels:

  • 🌟 Active Contributor - Submit quality PRs
  • ⭐ Trusted Contributor - 3+ merged PRs, given review rights
  • πŸ’Ž Core Team - Top contributors, invited by maintainers

Benefits:

  • Listed in README and release notes
  • Direct access to maintainer discussions
  • Priority support for your issues
  • Invitation to private roadmap planning

Hall of Fame

Top Contributors:

  • Coming soon! Be the first! πŸš€

πŸ“‹ Contribution Types

Code Contributions

  • New exchange integrations
  • AI model adapters
  • Bug fixes and improvements
  • Performance optimizations

Required:

  • βœ… Code compiles and runs
  • βœ… Follows code style guidelines
  • βœ… Includes basic tests (preferred)
  • βœ… Updates documentation if needed

Documentation

  • Tutorial writing
  • Translation (δΈ­ζ–‡, Русский, Π£ΠΊΡ€Π°Ρ—Π½ΡΡŒΠΊΠ°)
  • FAQ updates
  • Video guides

Rewards:

  • $50-200 for comprehensive guides
  • Recognition in docs
  • Contributor badge

Testing & QA

  • Bug reports with reproduction steps
  • Security vulnerability reports (see Security Policy)
  • Testnet verification
  • Performance testing

Rewards:

  • $50-500 for critical bug finds
  • Up to $1000 for security vulnerabilities
  • Recognition in security hall of fame

🌍 Community Channels

Primary Channels

PlatformPurposeLink
πŸ’¬ TelegramReal-time chat, questionsJoin
πŸ™ GitHubIssues, PRs, discussionsVisit
🐦 TwitterAnnouncements, updates@nofx_official

Core Team

Contact:

  • Technical questions β†’ Telegram or GitHub Issues
  • Business inquiries β†’ Twitter DM to core team
  • Security reports β†’ SECURITY.md

πŸ“… Community Events

Regular Activities

  • Weekly Updates - Development progress (Telegram)
  • Monthly AMA - Ask maintainers anything
  • Quarterly Roadmap - Future plans discussion

Upcoming Events

  • No scheduled events yet

Want to organize an event?

  • Contact core team on Telegram
  • Propose in GitHub Discussions
  • Tweet and tag @nofx_official

πŸŽ“ Learning Resources

For Contributors

Understanding NOFX:

Learning Materials:

  1. Before Contributing:

  2. For Exchange Integration:

  3. For AI Features:

    • Custom API Guide
    • MCP client code: mcp/client.go
    • Decision engine: decision/engine.go

πŸ›‘οΈ Community Guidelines

Our Values

  • Respect - Treat everyone with courtesy
  • Transparency - Open communication and decisions
  • Quality - High standards for contributions
  • Collaboration - Work together, help each other

Not Acceptable

  • ❌ Harassment or discrimination
  • ❌ Spam or self-promotion
  • ❌ Sharing malicious code
  • ❌ Violating Code of Conduct

Violations will result in:

  1. Warning
  2. Temporary ban
  3. Permanent ban (serious cases)

πŸ“Š Community Stats

MetricCount
GitHub StarsCheck repo
Contributors21+
Open IssuesCheck issues
Merged PRsCheck pulls


← Back to Documentation Home