Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tinchox5 authored Aug 20, 2024
1 parent 0e413d6 commit 524ea85
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
**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](https://github.com/zumerlab/orbit/discussions) and [Telegram group](https://t.me/ZumlyCommunity) 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.

**Community**

- [**GitHub discussions**](https://github.com/zumerlab/orbit/discussions): Engage with other contributors, ask questions, and share your experiences.
- [**Telegram group**](https://t.me/ZumlyCommunity): 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!

0 comments on commit 524ea85

Please sign in to comment.