Skip to content

Commit 770f784

Browse files
authored
Add ColPrac guide
1 parent 4432591 commit 770f784

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,22 @@
1-
# DynamicPPL
1+
# DynamicPPL.jl
22

33
[![Build Status](https://travis-ci.com/TuringLang/DynamicPPL.jl.svg?branch=master)](https://travis-ci.com/TuringLang/DynamicPPL.jl)
44
[![Codecov](https://codecov.io/gh/TuringLang/DynamicPPL.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/TuringLang/DynamicPPL.jl)
5+
[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
56

67
A domain-specific language and backend for probabilistic programming languages, used by [Turing.jl](https://github.com/TuringLang/Turing.jl).
8+
9+
## Do you want to contribute?
10+
11+
If you feel you have some relevant skills and are interested in contributing then please do get in touch and open an issue on Github.
12+
13+
This project follows the [ColPrac guide on collaborative practices](http://colprac.sciml.ai/), apart from the following slight variation:
14+
15+
- The master branch contains the most recent release at any point in time. All non-breaking changes (bug fixes etc.) are merged directly into master and a new patch version is released immediately.
16+
- A separate dev branch contains all breaking changes, and is merged into master when a minor version release happens.
17+
18+
For instance, suppose we are currently on version 0.13.5.
19+
20+
- If someone produces a bug fix, it is merged directly into master and bumps the version to 0.13.6. This change is also merged into dev so that it remains up-to-date with master.
21+
- If someone is working on a new feature that is not breaking (performance-related, fancy new syntax that is backwards-compatible etc.), the same happens.
22+
- New breaking changes are merged into dev until a release is ready to go, at which point dev is merged into master and version 0.14 is released.

0 commit comments

Comments
 (0)