Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 2.2 KB

Contributing Guide to Orbit

Welcome to Orbit!

We're excited to have you on board! This guide outlines how you can contribute to Orbit, help us test and improve it, and share your experiences with the community.

Getting Started

  1. Try Orbit out: Play around with Orbit, explore its features, and see how it works.
  2. Provide feedback: Share your thoughts, suggestions, and ideas on how to improve Orbit.
  3. Report bugs: If you encounter any issues, please report them on our GitHub issue tracker.
  4. Show your examples: Help us build a showcase gallery of examples by contributing your own use cases.
  5. Join the discussion: Participate in our GitHub discussions and Telegram group to connect with other contributors and get updates.

Documentation

  • Read the docs: Familiarize yourself with our documentation to understand how Orbit works.
  • Suggest improvements: If you find any errors or have suggestions for improving the documentation, please let us know.

Code Contributions

  • Fix bugs: Help us squash bugs by submitting pull requests.
  • New features: Suggest new features or enhancements and collaborate with us to implement them.

Spread the Word!

  1. Share your experience: Share your experience with Orbit on social media, blogs, or with your friends and colleagues.
  2. Write a review: Write a review of Orbit on our GitHub page or on your blog.
  3. Give a talk: Give a talk about Orbit at a conference, meetup, or webinar.
  4. Create content: Create content (videos, tutorials, blog posts, etc.) to help others learn about Orbit.
  5. Invite others: Invite others to join the Orbit community and contribute to its growth.

Community

  • GitHub discussions: Engage with other contributors, ask questions, and share your experiences.
  • Telegram group: Join our Telegram group for real-time discussions and updates.

Thank you!

Your contributions are invaluable to us. By participating in this community, you're helping shape the future of Orbit. Let's work together to make it amazing!