Skip to content

Latest commit

 

History

History
25 lines (13 loc) · 1 KB

CONTRIBUTING.md

File metadata and controls

25 lines (13 loc) · 1 KB

Contributing

What is a template?

Templates answers the question "How do I do X (with Y)?". An example would be "How do I create a web browser addon?" or "How do I display AR experiences with A-Frame?"

The template should be working out of the box or require as few efforts as possible.

A template showcases exactly 1 thing.

A template could be used as the starting point of a project.

How to document a template

Copy the "sub_readme_template.md" to the folder of your template and fill it.

You must comment at least the files mentionned in the section "How to start" and "How to modify".

Submitting a template without being comfortable with Git or GitHub

If you have a cool template but you don't know how to submit it, please create an issue and ping @zhakk-harn. You'll be guided through the process of submitting your code.

About the handling of PRs

Feel free to use any commit style you want because PRs will be systematically squash-merged.