Where to find the research
OSRI is the GitHub organization. Each study has its own repository directly under the organization. Open the study repository and use:
- README for its paper or working title, question, human lead, research areas, and current state.
- Files for sources, methods, analysis, results, and writing.
- Issues for tasks, questions, and ways to help.
- Pull requests to propose and review file changes.
Find a study in the research directory. Research areas help you find related studies; a study can appear in several areas while keeping one repository.
Research repository names#
Use the paper title, or its working title while the paper develops. Use lowercase words separated by hyphens for the repository name and keep the full title, with punctuation, in its README and directory entry. Avoid generic names such as project-1 or xr-research.
For example, Medical XR: from capabilities to sustainable use uses medical-xr-from-capabilities-to-sustainable-use.
Shared repositories#
| Repository | Role |
|---|---|
| osri | Entry guide, area indexes, research directory, publication records, standards, and administrative meta-research. |
| research-repository-template | Starting files for a new research repository. |
| .github | Organization profile, shared community templates, and the public Discussions forum. |
Each research project gets a separate repository. Its README holds the question, human lead, scope, and current research state. Its issues and pull requests hold tasks and proposed changes.
Area pages link to projects rather than copying their research. The hub publication register links related outputs. Meta-research is part of administering the whole group.
Start with the project template's few files. Add data, analysis, models, and result folders only when the work needs them. Keep large or restricted artifacts in an approved location and track permitted metadata and provenance.
The Simulation Lab is under development. A separate repository can hold shared capabilities when they become useful.
New project setup includes a human lead, shared standards version, licenses and data terms, and repository access settings. Template files do not replace access controls or branch settings. The initial publication uses branch protection without a required second reviewer, because OSRI currently has one founder.