File: CONTRIBUTING.md

package info (click to toggle)
emcee 3.1.6-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,460 kB
  • sloc: python: 2,496; makefile: 146; sh: 20
file content (44 lines) | stat: -rw-r--r-- 1,827 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
## How to contribute to emcee

### Expectations

emcee is developed and maintained in my spare time and, while I try to be
responsive, I don't always get to every issue immediately. If it has been more
than a week or two, feel free to ping me to try to get my attention. Do not
email me directly; all discussion should happen on [the mailing
list](https://groups.google.com/forum/#!forum/emcee-users).

### Did you find a bug?

**Ensure the bug was not already reported** by searching on GitHub under
[Issues](https://github.com/dfm/emcee/issues). If you're unable to find an
open issue addressing the problem, [open a new
one](https://github.com/dfm/emcee/issues/new). Be sure to include a **title
and clear description**, as much relevant information as possible, and the
simplest possible **code sample** demonstrating the expected behavior that is
not occurring.

### Did you write a patch that fixes a bug?

Open a new GitHub pull request with the patch. Ensure the PR description
clearly describes the problem and solution. Include the relevant issue number
if applicable.

### Do you intend to add a new feature or change an existing one?

First, read the [VISION](https://github.com/dfm/emcee/blob/main/VISION.md)
notes and make sure that your feature is consistent with those. In particular,
modifications of the core algorithm or additions of new algorithms are
unlikely to be approved. If your feature seems to be consistent, suggest it on
the [emcee-users mailing
list](https://groups.google.com/forum/#!forum/emcee-users) for some discussion
before opening a pull request.

### Do you have questions about the code or about MCMC in general?

**Do not open an issue.** Ask any questions on the [emcee-users mailing
list](https://groups.google.com/forum/#!forum/emcee-users).

Thanks!

[Dan](https://github.com/dfm)