Contribute with a browser

On this page

You can read the public guides without an account. Sign in to GitHub to post or edit files. No terminal, agent, or software installation is required.

Submit a first contribution#

  1. Choose a small task, such as the first source comparison.
  2. Open OSRI Q&A.
  3. Use a title such as First contribution: [question or task].
  4. Paste your note or table. Link the source and mark unchecked material.
  5. Ask a maintainer to add it to the project and arrange review.

Posts and attachments are public. Share only material you may disclose. For confidential coordination, email Cole before sending files.

Ask the maintainer to confirm the project, person responsible for the next action, and where the accepted note will be recorded. A post alone does not establish acceptance. You may use your preferred language.

Create a project#

Each study gets one repository. The repository is its home for research files, tasks, and proposed changes.

  1. Open research-repository-template.
  2. Choose Use this template, then Create a new repository.
  3. Select your account as owner, or ask an administrator to create an OSRI repository.
  4. Name the repository after the paper or working title, using lowercase words separated by hyphens, such as medical-xr-from-capabilities-to-sustainable-use. Choose visibility, then select Create repository from template. Public repositories expose their files and history.
  5. In the new repository, open README.md and use the pencil button to edit it.
  6. Use the full paper or working title as the README heading. Fill in the question, human lead, research areas, scope, state, and first task. Remove the setup prompts when finished.
  7. Preview the edit. Use the change steps below to request acceptance.
  8. Open Issues, then New issue. State the first task, expected result, and help needed.
  9. Share the repository link with an administrator to request a project ID and directory entry.

If an option is unavailable, ask a maintainer in Q&A. See GitHub's template instructions for the current interface.

Propose a file change#

A commit saves a file version. A branch keeps proposed edits separate. A pull request asks a maintainer to review and accept them.

After editing a file, select Commit changes. Choose a new branch and follow the prompts to create a pull request. Explain the task, sources, actual checks, and review still needed. Link the related issue or discussion.

If you lack write access, GitHub may ask you to fork the repository. A fork is a copy in your account. Follow the prompts to propose your change. The GitHub file-editing guide explains both routes.

You can instead post the proposed text in the project issue or Q&A. Ask a maintainer to prepare the file change and confirm how you will receive credit.

View source on GitHub