Skip to content

Commit

Permalink
Update readme with existing experiments (#8)
Browse files Browse the repository at this point in the history
* Update readme with existing experiments
* Add "CreateAnExperiment.md"
  • Loading branch information
AaronRobinsonMSFT authored Jul 13, 2020
1 parent 5e20ada commit 542dd85
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
11 changes: 11 additions & 0 deletions CreateAnExperiment.md
Original file line number Diff line number Diff line change
@@ -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.

<!-- common links -->

[main_branch_link]: https://github.com/dotnet/runtimelab/tree/master
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 542dd85

Please sign in to comment.