Create issue / pull request templates for core MagicBox projects

[jwflory]

Summary

Create a common set of issue / pull request templates that simplify reviewing new contributions and bug requests to core MagicBox projects

Background

Issue and pull request templates are a GitHub feature that let a project maintainer create a template that anyone filing an issue or creating a pull request sees. These are helpful to guide new contributors to leave more helpful bug reports / feature requests, getting valuable information for diagnosing problems, and to guide new contributors (e.g. providing a "checklist" of things to review before submitting).

Core MagicBox projects are:

• unicef/magicbox-open-api
• unicef/magicbox-maps

Details

The easiest option is to use a single issue / pull request template across all MagicBox-related repos. This simplifies adoption and ensures consistency for the contributor experience. However, this may not be possible.

Before creating a template, each project (or all projects) need to identify…

• Minimum required information for bug reports
  • What info is helpful to diagnose a problem
  • Version numbers? Logs?
• Helpful pointers for others making feature requests
  • What questions do we want to ask? Why does someone need a feature?
• Checklist of routine tasks every pull request should follow
  • Before someone commits code to the repo, what should they check for?
  • Are there guidelines for style they should follow? Should they run any tests before submitting a pull request?

This list may vary by project. Whether all MagicBox projects use the same templates or not depends on unique needs for each project. Alternatively, a "base" could be drafted, and then each project can tack specific requirements on at the end.

Action

Create issue / pull request templates for core MagicBox repos to help…

1. New contributors make a first contribution
2. Maintainers review contributions as the project scales up