Welcome

This repository contains essential files for setting up reports developed by CIID to support IDEA compliance and data quality efforts.

This documentation is designed for educators, administrators, and data specialists, and includes critical reports such as:

1. Significant Disproportionality
2. IDEA State Assessments

For report demos, setup instructions, and overview please visit the CIID documentation gitbook page:

https://center-for-the-integration-of-id.gitbook.io/ciid-reports

🛠️ Development Guidelines

To ensure a smooth development process, please follow these steps:

1. Fork from the develop branch

• Always fork a new branch from the develop branch for your work.
• Use descriptive names for your branches (e.g., bugfix/report-export-error or feature/new-dashboard-page).
• For more information on forking a branch visit: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo

2. Make your changes

• Commit your changes with clear and concise commit messages.
• Test your changes before submitting.

3. Submit a Pull Request

• When your work is complete, open a pull request to merge into the main branch.
• In your Pull Request description, include a brief summary of the changes and any relevant context or screenshots.
• ⚠️ Make sure your branch is up to date with the latest changes from develop before creating a PR.
• For more information on submittig a pull request visit: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests

4. Reporting Issues

If you’ve encountered a bug, have a feature idea, or want to request a new report:

• Open an issue using the appropriate template (Bug, Enhancement, or Report Request).
• Provide as much detail as possible, including steps to reproduce (for bugs) or a use case (for enhancements).