Analytics Middle Tier - Contributions

The Analytics Middle Tier Contribution projects are contributed views and collections the Ed-Fi community has used to pull information out of Ed-Fi. For more information on Analytics Middle Tier:

• Overview
• Documentation Site
• Analytics Middle Tier Source Code

Usage Guidelines

This repository provides a mechanism for community members to share their Views into the ODS with each other. Simply download the project and execute the SQL files that correlate to the Views you are interested in using. This is a great way to get started on your project without having to start from nothing. We would appreciate any modifications to be contributed back to the project so others can leverage your work.

The Analytics Middle Tier is an open source project and these views are also available as open source. By default all contributions are available under the terms of the Apache License, version 2.0. Please ensure that you maintain the appropriate licensing to contribute this work for others to reuse. If you wish to use terms other than the Apache 2.0 license then please include the license file with your views.

Contribution Guidelines

The contribution process for sharing your work is as simple as:

1. Clone this repository with git.
2. Create a new branch named after your organization and use case
3. Commit your contribution to that branch
4. Create a pull request to merge your branch back on to the "main" branch in GitHub project.
5. Your pull request will be reviewed by a repository manager and will be merged upon approval

There is an example contribution provided in the "Contribution Template" folder located in the repository.

The contribution Format should include:

1. Your contribution should be placed inside a new folder named after the use case you are solving for and your organization (e.g. "Early warning System - Ed-Fi")
2. In the root of your new folder you should include:
   1. readme.md
   2. mssql folder (optional to include your MSSQL views)
   3. postgres folder (optional to include your postgres views)
3. The readme.md should include the following information:
   1. A brief description of the use case.
   2. List the supported ODS/AMT versions.
   3. Description of data assumptions.
   4. (optional) Your contact information if community members have questions. It is understood that you are under no obligation to provide support; however, providing contact information helps in creating a community of practice.

Several Notes on your contribution:

1. You are not required to provide both MSSQL and postgres versions of your views.
2. The SQL you submit should only create the Views needed for your use case. Any other views, data manipulation, or database modification will NOT be accepted.
3. As long as your pull request follows these guidelines and appears to contribute something useful to the community, it will be approved and merged by the repository manager.

Using Git

If you are new to Git, you might want to first explore one of these resources:

• Git basics (from Atlassian)
• GitHub for Atom (from GitHub - use Git commands right from the MetaEd-IDE!)
• Resources to learn Git (from GitHub)
• Code submitted to this repository must be signed with an encryption key, see Signing Git commits on Tech Docs.

License

Copyright © Ed-Fi Alliance, LLC and contributors.

Licensed under the Apache License, version 2.0 license.