Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (33 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

51 lines (33 loc) · 2.7 KB

Contributing to Noggin

Thank you for taking the time to contribute to Noggin! We are on a mission to build the world's best free, open-source, and adaptive learning platform for students with special education needs.

Whether you are a professional software engineer, a UI/UX designer, an AI enthusiast, or a Special Education Teacher, your help is incredibly valuable to us.

🌟 Our Philosophy on Collaboration

Noggin is built openly and iteratively. We embrace modern rapid-prototyping workflows, visual application builders, and AI-assisted engineering to keep our development fast and focused entirely on student accessibility.

We welcome contributors of all technical skill levels. You do not need to be a senior backend programmer to make a massive impact here!

🛠️ How You Can Help

1. For Educators & Assistive Tech Specialists

You are the most important part of this project because you understand what exceptional students truly need.

  • Share Insights: Open a GitHub Issue to explain how a specific learning disability or sensory need can be better supported by our layout.
  • Request Lessons: Suggest new types of interactive matching, sorting, or language games.
  • Test Usability: Run our live app on classroom iPads or touchscreens and tell us where students get stuck.

2. For UI/UX Designers & Accessibility Experts

Our layout must minimize cognitive load and completely eliminate sensory overload.

  • Audit our components against Web Content Accessibility Guidelines (WCAG) principles.
  • Suggest optimized color palettes for our high-contrast modes.
  • Design cleaner, distraction-free card and button structures.

3. For Software Engineers & Builders

Help us optimize our codebase architecture, state management, and database queries.

  • Browse our open repository issues for bugs tagged with good-first-issue.
  • Optimize the local runtime logic for smooth performance on older classroom tablets.
  • Help refine our adaptive evaluation algorithms and data schemas.

🚀 Getting Started

  1. Explore: Look through our active Issues to find something you want to work on.
  2. Discuss: Comment on the issue to let us know you are taking it on so we can avoid duplicate work.
  3. Submit: Fork the repository, make your changes on a clean branch, and submit a clear Pull Request (PR) describing your improvements.

📜 Code of Conduct

We are dedicated to providing a welcoming, safe, and supportive environment for everyone. Please be respectful, patient, and kind to all community members, regardless of their technical background or experience level.

Thank you for helping us make education accessible to every single student!