File: CONTRIBUTING.md

package info (click to toggle)
python-jedi 0.10.0~git1%2Bf05c071-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 2,064 kB
  • ctags: 3,014
  • sloc: python: 16,997; makefile: 149; ansic: 13
file content (28 lines) | stat: -rw-r--r-- 1,204 bytes parent folder | download
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
Pull Requests are great (on the **dev** branch)! Readme/Documentation changes
are ok in the master branch.

 1. Fork the Repo on github.
 2. If you are adding functionality or fixing a bug, please add a test!
 3. Add your name to AUTHORS.txt
 4. Push to your fork and submit a **pull request to the dev branch**.

My **master** branch is a 100% stable (should be). I only push to it after I am
certain that things are working out. Many people are using Jedi directly from
the github master branch.

**Try to use the PEP8 style guide.**


Changing Issues to Pull Requests (Github)
-----------------------------------------

If you have have previously filed a GitHub issue and want to contribute code
that addresses that issue, we prefer it if you use
[hub](https://github.com/github/hub) to convert your existing issue to a pull
request. To do that, first push the changes to a separate branch in your fork
and then issue the following command:

    hub pull-request -b davidhalter:dev -i <issue-number> -h <your-github-username>:<your-branch-name>

It's no strict requirement though, if you don't have hub installed or prefer to
use the web interface, then feel free to post a traditional pull request.