Write common README template for all MagicBox repos

[jwflory]

Summary

Write a basic template for a README to be used by other MagicBox projects (possibly other UNICEF projects)

Background

A README is the front door to an open source project. It's the first impression a project makes on anyone, whether it's a potential user, contributor, or supporter. A good README should…

• Clearly and simply explain what the project is
• Explain how to use the project (if necessary), or point to full documentation on how to use
• Explain how to contribute (or point to full contributing guidelines)
• Mention any legal notices (e.g. what license the project uses)

Check out the maturity model for READMEs. Let's try to get some Level 4 READMEs! 😄

Details

Every README for each project will be different. This issue is not about writing specific READMEs, but writing a good base template that other repos or UNICEF staff members can use to write good READMEs.

Ideally, the deliverable product is a template that has some "fill-in-the-blank" things, but more questions to prompt a maintainer to answer when putting together their README. To do this successfully, I want to do more research on how we can encourage others to write Level 4 (or better) READMEs without writing it for them, as explained in the maturity model.

Outcome

General template for MagicBox / UNICEF projects to use for writing a README for their open source project, to help invite new contributors and make the "first impression" a good one

[jwflory]

After discussing with the team, this work might be too "high level". For now, we're going to try and focus time and energy on each individual project. Later, if we need to rethink about scaling up, we can revisit this.

Closing as wontfix.