CreateAnExperiment.md

Create an experiment

Experiments should be contained within a branch in the dotnet/runtimelab repository. Keeping all experiments branches in one repository helps with community visibility.

Steps to setup a new experiment

• Pick a good name for your experiment and create branch for it in dotnet/runtimelab. Branch names should be prefixed with feature/ in order to have official build support.
  • If the experiment is expected to require changes of .NET runtime itself, it should be branched off of dotnet/runtimelab:runtime-master that is a manually maitained mirror of dotnet/runtime:master.
  • Otherwise, the experiment should be branched off of dotnet/runtimelab:master to get the required boilerplate such as LICENSE.TXT.
• Submit a PR to update the README.MD with the name of your branch and a brief description of the experiment. Example: #19
• Create label area-<your experiment name> for tagging issues. The label should use color #d4c5f9.
• If your experiment is branched from dotnet/runtime:
  • Enable CI builds by editing eng/pipelines/runtimelab.yml in your branch. Example: #137
  • To avoid spurious github notifications for merges from upstream, delete .github/CODEOWNERS from your branch or replace it with setting specific to your experiment. Example: #26