Skip to content

Latest commit

 

History

History
68 lines (38 loc) · 3.74 KB

contribute.md

File metadata and controls

68 lines (38 loc) · 3.74 KB
Raw

Contribute

Verax is an open-source, community-driven project. It thrives on contributions from the ecosystem at all levels—whether it’s brainstorming ideas, implementing features, or maintaining the codebase.

And guess what? Yes, you! You can shape the roadmap, propose new features, and contribute to any component of the Verax stack. Here’s a guide to the many ways you can get involved and make a difference.

🛠️ Product Contributions

Verax already offers a robust set of features and supports a variety of use cases. But maybe you’ve spotted something missing? Or thought of a new feature that could unlock exciting possibilities?

  • Submit ideas and suggestions: Share your thoughts as GitHub issues.
  • Discuss with the community: Not sure what to propose? Start a debate on our Community Forum. Once the discussion is mature, summarize it into a GitHub issue.

🚀 First-Time Contributors

Feeling overwhelmed? Don’t worry—we’ve got you!

  • Explore “Good First Issues”: These are handpicked tasks that are simple, well-documented, and perfect for beginners.
  • Need help?: Ping us anytime on Discord. We’re here to guide you.

🎨 Design, UX, and UI

Great design enhances usability, and we welcome your creativity!

  • Submit your ideas: Have concepts for improving how Attestations are displayed?
  • Share designs: Send us Figmas, mockups, or any design feedback.
  • Explore visual upgrades: Help us enhance the Explorer or make our website shine.

📚 Documentation Contributions

Our documentation is shaped by community feedback, but it’s always evolving.

  • Need something new?: Open a GitHub issue to request a specific topic or tutorial.
  • Ready to write?: Open a PR in the documentation repository.
  • Prefer a simpler approach?: Draft your ideas in Notion, Google Docs, or your favorite tool and share the link. We’ll handle the Markdown and integration!

🐛 Bug Reports

Found a bug? Uh-oh! Don’t worry—here’s how to help us fix it:

🔧 Bug Fixes

If you’ve found a solution to an issue listed in our repository:

  • Submit a Pull Request (PR): Fix the bug and let the community celebrate your contribution!

🔒 Vulnerability Reporting

We prioritize security, but if you’ve discovered a vulnerability, we need to know.

  • Contact us privately: Reach out via email to ensure a secure and timely resolution.

📦 Dependencies Upgrades

Keeping our dependencies up-to-date ensures Verax remains modern and reliable.

  • Use pnpm workflows: Upgrade or fix dependency versions to avoid deprecated libraries in the stack.

💬 Still Have Questions?

Not sure how to contribute or have an idea that doesn’t fit into these categories? Let’s talk!

  • Reach out on Discord, Twitter, or Lens.
  • Share your thoughts, and together, we’ll make the Attestation world better!

Contributing to Verax isn’t just about code—it’s about building a better ecosystem together. So, jump in, share your ideas, and leave your mark. We can’t wait to collaborate with you!