Skip to content

Commit 0a38a36

Browse files
committed
init commit
1 parent 87d4aea commit 0a38a36

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,45 @@
11
# Contributing guide
22

3+
Thank you for your interest in contributing to PyMC and PyMC-experimental!
4+
5+
This page outlines the steps to follow if you wish to contribute to the pymc-experimental repo and clone the repo locally.
6+
7+
## Install locally
8+
**1**: Create a folder `pymc-devs` in your local machine and follow the [cloning PyMC locally](https://www.pymc.io/projects/docs/en/latest/contributing/pr_tutorial.html).
9+
10+
Since PyMC-experimental should integrate with the latest version of PyMC, it is recommended that any development work on PyMC-experimental must also work with the latest version of PyMC.
11+
12+
You should now have a local copy of PyMC under `pymc-devs/pymc`.
13+
14+
**2**: Fork the PyMC-experimental repo and clone it locally:
15+
16+
```
17+
git clone [email protected]:<your GitHub handle>/pymc-experimental.git
18+
cd pymc-experimental
19+
git remote add upstream [email protected]:pymc-devs/pymc-experimental.git
20+
```
21+
22+
Create a new conda environment by first installing the dependencies in the main PyMC repo:
23+
```
24+
conda env create -n pymc-experimental -f /path/to/pymc-devs/pymc/conda-envs/environment-dev.yml
25+
conda activate pymc-experimental
26+
pip install -e /path/to/pymc-devs/pymc
27+
28+
# ignores the specific pymc version to install pymc-experimental
29+
pip install -e /path/to/pymc-devs/pymc-experimental --no-deps --ignore-installed pymc
30+
```
31+
32+
## Develop the feature
33+
34+
**1** Develop the feature on your feature branch:
35+
```
36+
git checkout -b my-exp-feature
37+
```
38+
39+
40+
41+
You should now have a local copy of PyMC-experimental under `pymc-devs/pymc-experimental`.
42+
43+
**Final steps**: Review contributing guide in [PyMC's main page](https://www.pymc.io/projects/docs/en/latest/contributing/index.html).
44+
345
Page in construction, for now go to https://github.com/pymc-devs/pymc-experimental#questions.

0 commit comments

Comments
 (0)