Skip to content

Commit

Permalink
Update readme with existing experiments (dotnet/runtimelab#8)
Browse files Browse the repository at this point in the history
* Update readme with existing experiments
* Add "CreateAnExperiment.md"

Commit migrated from dotnet/runtimelab@542dd85
  • Loading branch information
AaronRobinsonMSFT authored Jul 13, 2020
0 parents commit 8968ab3
Showing 1 changed file with 11 additions and 0 deletions.
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

0 comments on commit 8968ab3

Please sign in to comment.