Skip to content
This repository has been archived by the owner on Jan 18, 2023. It is now read-only.

Propose a Standard Tool

will-nemo edited this page May 7, 2020 · 1 revision

This guide is to show you the standard for reporting code standard/tool to use for a oneleif project.

Great resource: https://github.com/immersive-web/proposals/blob/master/ProposalsIssueTemplate.md

Currently we have code standards we use for specific projects but all of our projects have the ability to change them. If you feel strongly about using a certain standard or technique, make an issue for that specific project using our provided template and it will be reviewed/discussed by everyone working on the project. If you can convince everyone by giving solid reasoning then we can change to that standard or use that tool you suggest.


Template

Title

Just enough information to be specific and memorable.

Summary

One or two paragraphs listing the problem being solved and the target audience for the idea.

Example use cases

Two or three examples of an end user with goals and a step-by-step description of how the proposed idea solves helps them achieve the goal.

A rough idea or two about implementation

One or two paragraphs about how the feature might be implemented, mostly to help clarify how you're thinking about the problem space and the underlying technologies that could solve the problems.