Adeyemi AdetunjiandRotimi Best
2526f4c227
* feat: checkpoint * feat: Migrate docs to Fumadocs * chore: docs layout * chore: - remove home route - make docs home route - remove docs prefix * chore: docs layout * chore: - reorder sidebar - fix home page redirect * chore: rename package to avoid error during pnpm clean * chore: remove private and sideEffects properties from package.json * chore: requested fixes * feat: update fumadocs layout * feat: hide theme switch on sidebar * add /docs * feat: enhance documentation and layout with new guides and updates - Added multiple how-to guides for creating courses, exercises, and managing organization settings. - Updated existing documentation for clarity and consistency, including renaming sections for better navigation. - Introduced new assets such as logos and favicon for improved branding. - Modified layout components to enhance user experience and visual appeal. - Updated package dependencies to include lucide-react for icon usage. * chore: update pnpm-lock.yaml with dependency version changes * add favicon * fix: update links in documentation for consistency - Corrected the links in the create-exercise and signup guides to ensure they point to the correct paths, enhancing clarity and navigation for users. * delete docs --------- Co-authored-by: Rotimi Best <[email protected]>
33 lines
1.9 KiB
Plaintext
33 lines
1.9 KiB
Plaintext
---
|
|
title: Developers Contribution Guide
|
|
description: Guidelines for contributing code to ClassroomIO.
|
|
---
|
|
|
|
First and foremost, we're absolutely thrilled that you're considering becoming a part of the community.
|
|
|
|
## Issue Hunters
|
|
|
|
Did you stumble upon a bug? Encountered a hiccup in deployment? Perhaps you have some user feedback to share? Your quickest route to help us out is by [raising an issue](https://github.com/rotimi-best/classroomio/issues/new/choose).
|
|
|
|
## Feature Architects
|
|
|
|
We invite innovative minds to contribute to the evolution of ClassroomIO. If you have a compelling feature proposal that could enhance our platform, please initiate a formal issue submission and apply the "Enhancement" label. We highly value and eagerly anticipate each unique idea presented by our community. To ensure thorough understanding and effective evaluation, kindly include a detailed rationale for your proposed feature. Your insights are crucial to our continuous growth and innovation.
|
|
|
|
## Pull Requests
|
|
|
|
Ready to dive into the code and make a real impact? Here's your path:
|
|
|
|
1. **Fork the Repository:** Fork our repository or use [Gitpod](/docs/contributor-guides/gitpod)
|
|
|
|
2. **Implementation:** Code it out, test it and apply your changes.
|
|
|
|
3. **Pull Request:** If you're ready to go, create a new pull request following our PR template
|
|
|
|
Would you prefer a chat before you dive into a lot of work? Our [Discord server](https://dub.sh/ciodiscord) is your harbor. Share your thoughts, and we'll meet you there with open arms. We're responsive and friendly, promise!
|
|
|
|
## Feature Ideas
|
|
|
|
If you spot a feature that isn't part of our official plan but could propel ClassroomIO forward, don't hesitate. Raise it as an enhancement issue, and let us know you're ready to take the lead. We'll be quick to respond.
|
|
|
|
Together, let's craft the future of ClassroomIO, making it better, bolder, and more brilliant!
|