forked from bokeh/bokeh
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use
git ls-files
to collect files for code quality tests (bokeh#5751)
* Use `git ls-files` in code quality tests This way we can test all checked-in files more easily. * Fix code quality issues * Make tests/test_code_quality_py work under Python 3 * Fix code quality issues in classifiers.txt
- Loading branch information
Showing
47 changed files
with
174 additions
and
241 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,67 +1,67 @@ | ||
# How to contribute | ||
|
||
We welcome users' contributions! However, we do have some requests for how contributions | ||
We welcome users' contributions! However, we do have some requests for how contributions | ||
should be made. Please read these guidelines in order to avoid surprises down the road. | ||
|
||
## Choosing something to work on | ||
|
||
The issue tracker has a list of items that you can start working on, classified by the labels: | ||
The issue tracker has a list of items that you can start working on, classified by the labels: | ||
|
||
* [`type:feature`](https://github.com/bokeh/bokeh/labels/type:%20feature) | ||
* [`type:task`](https://github.com/bokeh/bokeh/labels/type:%20task) | ||
* [`type:bug`](https://github.com/bokeh/bokeh/labels/type:%20bug) | ||
|
||
In order to avoid duplication of effort, it's always a good idea to comment on an issue | ||
In order to avoid duplication of effort, it's always a good idea to comment on an issue | ||
and let everybody know that you intend to work on it. | ||
|
||
## Opening a new issue | ||
|
||
1. Avoid duplicate reports. Search [GitHub](https://github.com/bokeh/bokeh/issues) and | ||
the [mailing list](https://groups.google.com/a/continuum.io/forum/#!forum/bokeh) for | ||
1. Avoid duplicate reports. Search [GitHub](https://github.com/bokeh/bokeh/issues) and | ||
the [mailing list](https://groups.google.com/a/continuum.io/forum/#!forum/bokeh) for | ||
similar or identical issues. Keyword searches for your error messages are usually effective. | ||
2. The issue may already be resolved. If possible, try to reproduce the issue using most recent | ||
[development build](http://bokeh.pydata.org/docs/installation.html#developer-builds) of bokeh, | ||
or even better, by building and installed from the `master` branch. | ||
3. Try to include a *minimal*, self-contained, reproducible test case or example. The more code | ||
or data we have to have to reproduce the issue, the less likely we will be able to. | ||
[development build](http://bokeh.pydata.org/docs/installation.html#developer-builds) of bokeh, | ||
or even better, by building and installed from the `master` branch. | ||
3. Try to include a *minimal*, self-contained, reproducible test case or example. The more code | ||
or data we have to have to reproduce the issue, the less likely we will be able to. | ||
4. Include relevant system information. At minimum, you should provide output of: | ||
|
||
`python -c "import bokeh; print(bokeh.__version__)"` | ||
|
||
5. Include relevant browser information (if the issue is browser-related). Just saying that you | ||
use Chrome is generally not sufficient. We may ask you for additional information to | ||
use Chrome is generally not sufficient. We may ask you for additional information to | ||
reproduce and fix the issue. | ||
6. Include relevant JavaScript console and/or `bokeh serve` logs. | ||
7. If the problem is user interface related, it is *always* good to include a screenshot. | ||
6. Include relevant JavaScript console and/or `bokeh serve` logs. | ||
7. If the problem is user interface related, it is *always* good to include a screenshot. | ||
8. State the expected behavior. | ||
|
||
## Creating a pull request (PR) | ||
|
||
1. Make sure that there is a corresponding issue for your change first. If there isn't yet, | ||
1. Make sure that there is a corresponding issue for your change first. If there isn't yet, | ||
create one. | ||
2. Create a fork of the Bokeh repository on GitHub (this is only done before *first*) contribution). | ||
3. Create a branch off the `master` branch with a meaningful name. Preferably include issue number | ||
and a few keywords, so that we will have a rough idea what the branch refers to, without looking | ||
and a few keywords, so that we will have a rough idea what the branch refers to, without looking | ||
up the issue. As an example: `786_property_names`. | ||
4. Commit your changes and push them to GitHub. | ||
5. Create a pull request against the origin's `master` branch. The PR must have a meaningful title | ||
5. Create a pull request against the origin's `master` branch. The PR must have a meaningful title | ||
and a message explaining what was achieved, what remains to be done, maybe an example, etc. | ||
6. We don't accept code contributions without tests. If there are valid reasons for not including a | ||
6. We don't accept code contributions without tests. If there are valid reasons for not including a | ||
test, please discuss this in the issue. | ||
7. We will review your PR as time permits. Reviewers may comment on your contributions, ask | ||
you questions regarding the implementation or request changes. If changes are requested, don't | ||
start a new PR, (push new commits to the existing one). Do *NOT* rebase, amend, or cherry-pick | ||
published commits. Any of those actions will make us start the review from scratch. If you need | ||
published commits. Any of those actions will make us start the review from scratch. If you need | ||
updates from `master`, just merge it into your branch. | ||
|
||
## DOs and DON'Ts | ||
|
||
* **DO** follow our coding style. | ||
* **DO** include new tests when adding new features. | ||
* **DO** include regression tests when fixing bugs. | ||
* **DO** include new tests when adding new features. | ||
* **DO** include regression tests when fixing bugs. | ||
* **DO** keep the discussions focused. When a new or related topic comes up it's often better to | ||
create new issue than to side track the discussion. | ||
* **DON'T** surprise us with big pull requests. Instead, file an issue and start a discussion so we | ||
can agree on a direction before you invest a large amount of time. | ||
* **DON'T** commit code that you didn't write. If you find BSD license compatible code that you | ||
* **DON'T** commit code that you didn't write. If you find BSD license compatible code that you | ||
think would be useful to add to this project, file an issue and start a discussion first. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,4 +3,3 @@ Author: Jake Vanderplas <[email protected]> | |
Date: Sat Apr 19 08:18:20 2014 -0700 | ||
|
||
BUG: correctly handle color='none' | ||
|
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.