immersive-web / immersive-web/model-element
Rename explainer to proposal
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 86
- Forks
- 12
- Avg merge
- 7h 12m
- Merged PRs (30d)
- 1
Description
As we start spec development, we are likely to make breaking changes. As such, the explainer won't match the spec anymore.
It would probably be better to create a fresh explainer that is always sync'ed with the spec. That is, require that all pull requests that include author-impacting changes include a changes to the explainer.
- rename the current explainer -> proposal.md or, probably better... move it to historicalAndEvolution.md (which we could probably just move to the wiki).
- create a new explainer.md
- add GitHub pull request template to enforce the change to explainer.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the current explainer and review the repository's documentation structure and existing GitHub pull request template conventions. Separate the historical material from the new proposal, create the synchronized explainer, and update the template so author-impacting changes call for an explainer update.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, markdown
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 28/100