|
1 | 1 | # Guidelines for Contributing |
2 | 2 |
|
3 | | -As a scientific community-driven software project, PyMC welcomes contributions from interested individuals or groups. These guidelines are provided to give potential contributors information to make their contribution compliant with the conventions of the PyMC project, and maximize the probability of such contributions to be merged as quickly and efficiently as possible. |
4 | | - |
5 | | -There are 4 main ways of contributing to the PyMC project (in descending order of difficulty or scope): |
6 | | - |
7 | | -* Adding new or improved functionality to the existing codebase |
8 | | -* Fixing outstanding issues (bugs) with the existing codebase. They range from low-level software bugs to higher-level design problems. |
9 | | -* Contributing or improving the documentation (`docs`) or examples (`pymc/examples`) |
10 | | -* Submitting issues related to bugs or desired enhancements |
11 | | - |
12 | | -## Opening issues |
13 | | - |
14 | | -We appreciate being notified of problems with the existing PyMC code. We prefer that issues be filed the on [Github Issue Tracker](https://github.com/pymc-devs/pymc/issues), rather than on social media or by direct email to the developers. |
15 | | - |
16 | | -Please verify that your issue is not being currently addressed by other issues or pull requests by using the GitHub search tool to look for key words in the project issue tracker. |
17 | | - |
18 | | -Filter on the ["beginner friendly"](https://github.com/pymc-devs/pymc/issues?q=is%3Aopen+is%3Aissue+label%3A%22beginner+friendly%22) label for issues which are good for new contributors. |
19 | | - |
20 | | -## Etiquette for code contributions |
21 | | -* When you start working working on an issue, open a `Draft` pull request as soon as you make your first commit (see steps below). |
22 | | -* Before opening a PR with a new feature, please make a proposal by opening an [issue](https://github.com/pymc-devs/pymc/issues) or [Discussion](https://github.com/pymc-devs/pymc/discussions) with the maintainers. Depending on the proposal we might direct you to other places such as [`pymc-experimental`](https://github.com/pymc-devs/pymc-experimental) or [`pymc-examples`](https://github.com/pymc-devs/pymc-examples). |
23 | | -* Any issue without an open pull request is available for work. |
24 | | - * If a pull request has no recent activity it may be closed, or taken over by someone else. |
25 | | - * The specific timeframe for "recent" is hard to define as it depends on the contributor the specific code change, and other contextual factors. As a rule of thumb in a normal pull request with no other blockers there is typically activity every couple of days. |
26 | | - * The core devs will make their best judgement when opting to close PRs or reassign them to others. |
27 | | -* If unsure if an issue ticket is available feel free to ask in the issue ticket. Note however, that per the previous point an open pull request is way to claim an issue ticket. Please do not make unrealistic pledges in the issue tickets. |
28 | | -* It's okay if you are delayed or need to take a break, but please leave a comment in the pull request if you cannot get it to a state where it can be merged. Depending on the change (urgent bugfix vs. new feature) the core devs can determine if the PR needs to be reassigned to get the work done. |
29 | | - |
30 | | -## Contributing code via pull requests |
31 | | - |
32 | | -While issue reporting is valuable, we strongly encourage users who are inclined to do so to submit patches for new or existing issues via pull requests. This is particularly the case for simple fixes, such as typos or tweaks to documentation, which do not require a heavy investment of time and attention. |
33 | | - |
34 | | -Contributors are also encouraged to contribute new code to enhance PyMC's functionality, also via pull requests. Please consult the [PyMC documentation](https://pymc-devs.github.io/pymc/) to ensure that any new contribution does not strongly overlap with existing functionality. |
35 | | - |
36 | | -The preferred workflow for contributing to PyMC is to fork the [GitHub repository](https://github.com/pymc-devs/pymc/), clone it to your local machine, and develop on a feature branch. |
37 | | - |
38 | | -### Steps |
39 | | - |
40 | | -1. Read the [Etiquette for code contributions](#etiquette-for-code-contributions). |
41 | | - |
42 | | -1. Fork the [project repository](https://github.com/pymc-devs/pymc/) by clicking on the 'Fork' button near the top right of the main repository page. This creates a copy of the code under your GitHub user account. |
43 | | - |
44 | | -1. Clone your fork of the PyMC repo from your GitHub account to your local disk, and add the base repository as a remote: |
45 | | - |
46 | | - ```bash |
47 | | - git clone [email protected]: <your GitHub handle >/pymc.git |
48 | | - cd pymc |
49 | | - git remote add upstream [email protected]:pymc-devs/pymc.git |
50 | | - ``` |
51 | | - |
52 | | -1. Create a ``feature`` branch to hold your development changes: |
53 | | - |
54 | | - ```bash |
55 | | - git checkout -b my-feature |
56 | | - ``` |
57 | | - |
58 | | - Always use a ``feature`` branch. It's good practice to never routinely work on the ``main`` branch of any repository. |
59 | | - |
60 | | -1. Project requirements are in ``requirements.txt``, and libraries used for development are in ``requirements-dev.txt``. The easiest (and recommended) way to set up a development environment is via [miniconda](https://docs.conda.io/en/latest/miniconda.html): |
61 | | - |
62 | | - ```bash |
63 | | - conda env create -f conda-envs/environment-dev-py39.yml # or py38 or py37 |
64 | | - conda activate pymc-dev-py39 |
65 | | - pip install -e . |
66 | | - ``` |
67 | | - |
68 | | - _Alternatively_ you may (probably in a [virtual environment](https://docs.python-guide.org/dev/virtualenvs/)) run: |
69 | | - |
70 | | - ```bash |
71 | | - pip install -e . |
72 | | - pip install -r requirements-dev.txt |
73 | | - ``` |
74 | | -<!-- Commented out because our Docker image is outdated/broken. |
75 | | - Yet another alternative is to create a docker environment for development. See: [Developing in Docker](#Developing-in-Docker). |
76 | | ---> |
77 | | - |
78 | | -1. Develop the feature on your feature branch. |
79 | | - ```bash |
80 | | - git checkout -b my-cool-bugfix |
81 | | - ``` |
82 | | - |
83 | | -1. Before committing, please run `pre-commit` checks. |
84 | | - ```bash |
85 | | - pip install pre-commit |
86 | | - pre-commit run --all # 👈 to run it manually |
87 | | - pre-commit install # 👈 to run it automatically before each commit |
88 | | - ``` |
89 | | - |
90 | | -1. Add changed files using ``git add`` and then ``git commit`` files: |
91 | | - ```bash |
92 | | - git checkout -b my-cool-bugfix |
93 | | - git add modified_files |
94 | | - git commit |
95 | | - ``` |
96 | | - |
97 | | - to record your changes locally. |
98 | | - |
99 | | -1. After committing, sync with the base repository in case there have been any changes: |
100 | | - ```bash |
101 | | - git fetch upstream |
102 | | - git rebase upstream/main |
103 | | - ``` |
104 | | - |
105 | | - Then push the changes to the fork in your GitHub account with: |
106 | | - |
107 | | - ```bash |
108 | | - git push -u origin my-cool-bugfix |
109 | | - ``` |
110 | | - |
111 | | -1. Go to the GitHub web page of your fork of the PyMC repo. Click the 'Pull request' button to open a pull request to the main project. Our CI pipeline will start running tests* and project maintainers can start reviewing your changes. |
112 | | - <sup>*If this is your first contribution, the start of some CI jobs will have to be approved by a maintainer.</sup> |
113 | | - |
114 | | -### Pull request checklist |
115 | | - |
116 | | -We recommended that your contribution complies with the following guidelines before you submit a pull request: |
117 | | - |
118 | | -* If your pull request addresses an issue, please use the pull request title to describe the issue and mention the issue number in the pull request description. This will make sure a link back to the original issue is created. |
119 | | - |
120 | | -* All public methods must have informative docstrings with sample usage when appropriate. |
121 | | - |
122 | | -* Please select "Create draft pull request" in the dropdown menu when opening your pull request to indicate a work in progress. This is to avoid duplicated work, to get early input on implementation details or API/functionality, or to seek collaborators. |
123 | | - |
124 | | -<!-- Commented out because our Docker image is outdated/broken. |
125 | | -See [Developing in Docker](#Developing-in-Docker) for information on running the test suite locally. |
126 | | ---> |
127 | | - |
128 | | -* Documentation and high-coverage tests are necessary for enhancements to be accepted. |
129 | | - |
130 | | -* Depending on the functionality, please consider contributing an example Jupyter Notebook to [`pymc-examples`](https://github.com/pymc-devs/pymc-examples). Examples should demonstrate why the new functionality is useful in practice and, if possible, compare it to other methods available in PyMC. |
131 | | - |
132 | | -* __No `pre-commit` errors:__ see the [Python code style](https://github.com/pymc-devs/pymc/wiki/Python-Code-Style) and [Jupyter Notebook style](https://github.com/pymc-devs/pymc/wiki/PyMC-Jupyter-Notebook-Style-Guide) page from our Wiki on how to install and run it. |
133 | | - |
134 | | -In addition to running `pre-commit`, please also run tests: |
135 | | - |
136 | | -```bash |
137 | | -pip install pytest pytest-cov coverage |
138 | | - |
139 | | -# To run a subset of tests |
140 | | -pytest --verbose pymc/tests/<name of test>.py |
141 | | - |
142 | | -# To get a coverage report |
143 | | -pytest --verbose --cov=pymc --cov-report term-missing pymc/tests/<name of test>.py |
144 | | -``` |
| 3 | +The guidelines for contributing to the PyMC project are available |
| 4 | +on [our documentation](https://docs.pymc.io/en/latest/contributing/index.html) |
145 | 5 |
|
146 | 6 | <!-- Commented out because our Docker image is outdated/broken. |
147 | 7 | ## Developing in Docker |
@@ -172,14 +32,3 @@ accessed with |
172 | 32 | docker exec -it pymc jupyter notebook list |
173 | 33 | ``` |
174 | 34 | --> |
175 | | - |
176 | | -## Style guide |
177 | | - |
178 | | -We have configured a pre-commit hook that checks for `black`-compliant code style. |
179 | | -We encourage you to configure the pre-commit hook as described in the [PyMC Python Code Style Wiki Page](https://docs.pymc.io/en/latest/contributing/python_style.html), because it will automatically enforce the code style on your commits. |
180 | | - |
181 | | -Similarly, consult the [PyMC's Jupyter Notebook Style](https://docs.pymc.io/en/latest/contributing/jupyter_style.html) guides for notebooks. |
182 | | - |
183 | | -For documentation strings, we use [numpy style](https://numpydoc.readthedocs.io/en/latest/format.html) to comply with the style that predominates in our upstream dependencies. |
184 | | - |
185 | | -__This guide was derived from the [scikit-learn guide to contributing](https://github.com/scikit-learn/scikit-learn/blob/master/CONTRIBUTING.md)__ |
0 commit comments