From 542dd851129f974632dddaa24a2b9cb214fd5975 Mon Sep 17 00:00:00 2001 From: Aaron Robinson Date: Mon, 13 Jul 2020 14:57:21 -0700 Subject: [PATCH] Update readme with existing experiments (#8) * Update readme with existing experiments * Add "CreateAnExperiment.md" --- CreateAnExperiment.md | 11 +++++++++++ README.md | 6 +++++- 2 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 CreateAnExperiment.md diff --git a/CreateAnExperiment.md b/CreateAnExperiment.md new file mode 100644 index 000000000000..324ef578aa65 --- /dev/null +++ b/CreateAnExperiment.md @@ -0,0 +1,11 @@ +# Create an experiment + +Experiments should be contained within a branch in the repository. Instead of using forks of the `dotnet/runtimelab` repository to house experiments, keep branches in the official repository which helps with community visibility. Once an experiment branch is pushed up, remember to submit a PR to update the [README.MD](README.MD#Active%20Experimental%20Projects) in the [main branch][main_branch_link] with the name of the branch and a brief description of the experiment. + +Things to consider: + +- Experiments often involve updates to the [runtime](https://github.com/dotnet/runtime). Instead of branching off of the [main branch][main_branch_link] consider branching from the [official runtime branch](https://github.com/dotnet/runtimelab/tree/runtime-master). Including the entire runtime permits a self contained experiment that is easy for the community to try out. + + + +[main_branch_link]: https://github.com/dotnet/runtimelab/tree/master \ No newline at end of file diff --git a/README.md b/README.md index 23a791fee36f..8d259a9a9510 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,11 @@ This repo is for experimentation and exploring new ideas that may or may not mak Currently, this repo contains the following experimental projects: -- TODO +- [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. +- [Utf8String](https://github.com/dotnet/runtimelab/tree/Utf8String) - A new UTF-8 String data type in the runtime. + +You can create your own experiment, learn more [here](CreateAnExperiment.md)! ## Filing issues