sphinx/source/contributing.rst

3 Contributing to bpython
6 Thanks for working on bpython!
13 `#bpython <irc://irc.oftc.net/bpython>`_ on OFTC is particularly useful,
20 bpython supports Python 3.6 and newer. The code is compatible with all
29     $ virtualenv bpython-dev
30     # necessary every time you work on bpython
31     $ source bpython-dev/bin/activate
33 Fork bpython in the GitHub web interface, then clone the repo:
37     $ git clone git@github.com:YOUR_GITHUB_USERNAME/bpython.git
38     # or "git clone https://github.com/YOUR_GITHUB_USERNAME/bpython.git"
40 Next install your development copy of bpython and its dependencies:
44     $ cd bpython
45     # install bpython and required dependencies
52     # this runs your modified copy of bpython!
53     $ bpython
79 As a first dev task, I recommend getting `bpython` to print your name every
82 To run tests from the bpython directory:
92 The documentation is included in the bpython repository. After
93 checking out the bpython repository and installing `sphinx` as described in
113     $ virtualenv bpython-site-dev
114     $ source bpython-site-dev/bin/activate
131     $ source bpython-site-dev/bin/activate
141 .. _GitHub issue tracker: https://github.com/bpython/bpython/issues
142 .. _bite-size: https://github.com/bpython/bpython/labels/bitesize