You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+13-1Lines changed: 13 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,17 @@ Please verify that your issue is not being currently addressed by other issues o
17
17
18
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
19
20
-
# Contributing code via pull requests
20
+
## Etiquiette for code contributions
21
+
* When you start working working on an issue, open a `Draft` pull request as soon as you're doing the first steps (see steps below).
22
+
* Before opening a PR with a new feature, please propose it in 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.
27
+
* In accordance with the previous point, please don't make unrealistic "_I want to work on this issue_" pledges.
28
+
* It's okay if priorities change, but please communicate if you can't get a PR to the finish line, or that you're taking a break. Depending on the change (urgent bugfix vs. new feature) others might want to take over to get the work done.
29
+
30
+
## Contributing code via pull requests
21
31
22
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.
23
33
@@ -27,6 +37,8 @@ The preferred workflow for contributing to PyMC is to fork the [GitHub repositor
27
37
28
38
### Steps
29
39
40
+
1. Read the [Contributing etiquette section](#etiquiette-for-code-contributions).
41
+
30
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.
31
43
32
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:
0 commit comments