diff --git a/CreateAnExperiment.md b/CreateAnExperiment.md index 5fd8eee24ceb..39b089c7deee 100644 --- a/CreateAnExperiment.md +++ b/CreateAnExperiment.md @@ -4,11 +4,11 @@ Experiments should be contained within a branch in the dotnet/runtimelab reposit ## Steps to setup a new experiment -- Pick a good name for your experiment and create branch for it in dotnet/runtimelab. +- 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](https://github.com/dotnet/runtimelab/tree/runtime-master) that is a manually maitained mirror of [dotnet/runtime:master](https://github.com/dotnet/runtime/tree/master). - Otherwise, the experiment should be branched off of [dotnet/runtimelab:master](https://github.com/dotnet/runtimelab/tree/master) to get the required boilerplate such as LICENSE.TXT. - Submit a PR to update the [README.MD](https://github.com/dotnet/runtimelab/blob/master/README.md#active-experimental-projects) with the name of your branch and a brief description of the experiment. Example: [#19](https://github.com/dotnet/runtimelab/pull/19/files) - Create label `area-` 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: [#25](https://github.com/dotnet/runtimelab/pull/25/files) - - 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](https://github.com/dotnet/runtimelab/pull/26/files) \ No newline at end of file + - 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](https://github.com/dotnet/runtimelab/pull/26/files) diff --git a/README.md b/README.md index cf934cf063fe..587dad7b38f2 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,9 @@ This repo is for experimentation and exploring new ideas that may or may not mak Currently, this repo contains the following experimental projects: - [DllImportGenerator](https://github.com/dotnet/runtimelab/tree/DllImportGenerator) - Roslyn Source Generator used for generating P/Invoke IL stubs. -- [JsonCodeGen](https://github.com/dotnet/runtimelab/tree/JsonCodeGen) - Code generation for JSON. -- [NativeAOT](https://github.com/dotnet/runtimelab/tree/NativeAOT) - .NET runtime optimized for ahead of time compilation. -- [Utf8String](https://github.com/dotnet/runtimelab/tree/Utf8String) - A new UTF-8 String data type in the runtime. +- [JsonCodeGen](https://github.com/dotnet/runtimelab/tree/feature/JsonCodeGen) - Code generation for JSON. +- [NativeAOT](https://github.com/dotnet/runtimelab/tree/feature/NativeAOT) - .NET runtime optimized for ahead of time compilation. +- [Utf8String](https://github.com/dotnet/runtimelab/tree/feature/Utf8String) - A new UTF-8 String data type in the runtime. You can create your own experiment, learn more [here](CreateAnExperiment.md)!