Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update readme with existing experiments #8

Merged
merged 2 commits into from
Jul 13, 2020
Merged

Update readme with existing experiments #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d7afe61
Update readme with existing experiments
AaronRobinsonMSFT Jul 13, 2020
54d40d9
feedback
AaronRobinsonMSFT Jul 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CreateAnExperiment.md
View file
Open in desktop
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
View file
Open in desktop
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