Envisage — Organization Guidelines

We are a student-led innovation team passionate about technology, sustainability, and problem-solving. From building digital systems that improve school life, to raising awareness about issues concerning the community, to showcasing groundbreaking ICT projects at major exhibitions—our mission is simple:

Create solutions that matter.

This repository serves as the central operational manual for all Envisage GitHub projects.

Purpose of This Repository

This repository defines how Envisage builds, collaborates, and maintains its projects.

It exists to:

• Standardize development practices across all projects
• Ensure consistency in code, structure, and design
• Provide onboarding guidance for new members
• Document workflows, expectations, and responsibilities
• Maintain quality and scalability of Envisage systems

If you are contributing to any Envisage project, this repository is mandatory reading.

Who This Is For

• Developers (Frontend / Backend / Firebase)
• Designers (UI/UX contributors)
• Project managers / coordinators
• New members onboarding into Envisage

What You’ll Find Here

1. Contribution Guidelines

Defines how to:

• Work with GitHub repositories
• Create branches and commits
• Submit pull requests
• Participate in code reviews

➡️ See: CONTRIBUTING.md

2. Coding Standards

Ensures consistency across all Envisage projects:

• Naming conventions (files, variables, functions)
• Code formatting and structure
• Reusability and modular design

3. Project Structure Standards

Defines how all projects should be organized:

• Folder structure conventions
• Separation of UI, logic, and data layers
• Asset management (images, icons, etc.)

4. Workflow & Collaboration

Explains how work moves across the team:

• Task management using GitHub Issues
• Development lifecycle:
  • To Do → In Progress → Review → Done
• Branching strategy
• Team collaboration expectations

5. Issue & PR Templates

Standardized templates for:

• Bug reports
• Feature requests
• Pull requests

Core Principles

All Envisage projects must follow these principles:

• Clarity over complexity — Write understandable code
• Consistency over preference — Follow shared standards
• Functionality first — Design supports usability
• Collaboration over isolation — Work as a team
• Real-world impact — Build solutions that solve actual problems

What This Repository Is NOT

• Not a project repository
• Not for storing application code
• Not for experiments or prototypes This is strictly for standards, documentation, and governance.

Getting Started

1. Clone this repository:

   git clone https://github.com/envisage256/instructions.git

2. Read:

• README.md (this file)
• CONTRIBUTING.md

3. Follow all standards before contributing to any Envisage repo

Join The Journey

Stay connected with Envisage across all platforms:

              

Final Note

This repository evolves as Envisage grows.
Standards will improve, workflows will refine, and expectations will scale.

Stay aligned. Build responsibly. Ship impact.