Create and Test Developer Engagement Framework
In conjunction #116 (closed), I would like to establish a test framework for developer engagement. This is a general framework that outlines ways the CCAO generates a community of engaged developers that creates public value. This value may be through direct improvements to the CCAO's data or valuation code, or by creating value for other outside stakeholders and/or elected officials. This test framework will include the following components:
- A written contribution guide for external stakeholders.
- A set of documents that define the relationship between CCAO and external contributors.
- A set of test-cases for contribution, with an analysis of those cases.
To that end, here are the major portions of work that need to be completed. I have tried to list them in order that they need to be completed.
Policy & Legal
-
Conduct a survey of the material on 18F's repository. Note ideas and/or practices we can use. -
Draft a preliminary workflow showing the relationship between the CCAO and an external contributor from first contact to final product. -
See (O:\CCAODATA\documentation\Porcess and Code Documentation\Process Diagrams.vsdx)
-
Draft a Code of Conduct. -
Re-write this in a fillable form O:\CCAODATA\documentation\Collaborators\Free Data Subscription.pdf -
Draft a statement of interest document that is a fillable form (LaTex or Markdown? Webform if possible?). This document should outline: -
To be completed by contributor:
- Who is the eternal contributor? Who do they work for? Do they have real estate interests?
- What is their project?
- What resources will they require to complete the project?
- What is the nature of their submission? (People scripting directly in R are very helpful, but not necessary)
-
To be completed by the CCAO:
- Concerns about the project
- Conditions for Success/failure (I will terminate the project under X,Y,Z conditions. I will accept the work if X, Y Z are met)
- How will the work be evaluated? Who will be responsible for tracking, evaluating the work?
- Maximium allowable time frame? Due date, if applicable.
-
To be completed at the end of the project:
- Was the project successful? If not, why not?
- What was the project's impact?
-
Draft a legal agreement between CCAO and the external applicant: * NDA for the duration of the project. * Their contribution does not conflict with any other agreements (e.g. an IP agreement with employer) * They have not misrepresented their identity. * Other items as advised.
-
Draft an external contribution Guideline for the repo which connects all these documents in a narrative.
Data Science @takando , this will be your part.
-
Walk each test case through the drafted documents above. Start with #120 (closed) . -
Work with each contributor to integrate their work into our code base. -
Evaluate the impact of their contribution.
Communications @ssmithassessor , your optional portion.
-
Press releases and other coms material.