m26508134
/
docklet
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Create README.md

This commit is contained in:
Cao, Donggang 2016-06-02 12:09:36 +08:00
parent f674fc9783
commit b006c2e272
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/pullreqexp/README.md Normal file
View File

@ -0,0 +1,28 @@
Pull Requests of Experiments
============================
Some contributors may experiment new features and send pull requests to Docklet official repository. Sometimes the requests will be refused for reasons like functional incompatibility, deviation of development plan, lacking of fully testing, etc. However, some experiments may be very interesting and helpful. Therefore we recommend contributors write down the goal, design, and evaluation of their experiments in markdown format, and send pull requests here about the markdown file.
## Guide
1. Experiment on the forked unias/docklet repository and make sure it work as expected
2. Switch to **experiment** branch, write down a markdown doc named to document the experiment
3. Send a pull request to unias/docklet **experiment** branch
## Doc template
```
# Title of the Experiments
Author: [Author name](Author email)
Source Code: https://github.com/yourname/docklet/
## Goal
## Design
## Experiments
## Summary
```