Skip to content

Commit a9b0998

Browse files
committed
Fixed some documentation when I was checking if install dependencies where mentioned in docs..
1 parent 69c8892 commit a9b0998

1 file changed

Lines changed: 30 additions & 13 deletions

File tree

CONTRIBUTING.md

Lines changed: 30 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ local disk:
3131
$ git checkout -b feature/my-feature
3232
```
3333

34-
Always use a ``feature`` branch. It's good practice to never work on the ``master`` or ``develop`` branch! To make the nature of your pull request easily visible, please perpend the name of the branch with the type of changes you want to merge, such as ``feature`` if it contains a new feature, ``fix`` for a bugfix, ``doc`` for documentation and ``maint`` for other maintenance on the package.
34+
Always use a ``feature`` branch. It's good practice to never work on the ``master`` or ``develop`` branch!
35+
To make the nature of your pull request easily visible, please prepend the name of the branch with the type of changes you want to merge, such as ``feature`` if it contains a new feature, ``fix`` for a bugfix, ``doc`` for documentation and ``maint`` for other maintenance on the package.
3536

3637
4. Develop the feature on your feature branch. Add changed files using ``git add`` and then ``git commit`` files:
3738

@@ -59,7 +60,15 @@ We recommended that your contribution complies with the
5960
following rules before you submit a pull request:
6061

6162
- Follow the
62-
[pep8 style guilde](https://www.python.org/dev/peps/pep-0008/).
63+
[pep8 style guide](https://www.python.org/dev/peps/pep-0008/).
64+
With the following exceptions or additions:
65+
- The max line length is 100 characters instead of 80.
66+
- When creating a multi-line expression with binary operators, break before the operator.
67+
- Add type hints to all function signatures.
68+
(note: not all functions have type hints yet, this is work in progress.)
69+
- Use the [`str.format`](https://docs.python.org/3/library/stdtypes.html#str.format) over [`printf`](https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting) style formatting.
70+
E.g. use `"{} {}".format('hello', 'world')` not `"%s %s" % ('hello', 'world')`.
71+
(note: old code may still use `printf`-formatting, this is work in progress.)
6372

6473
- If your pull request addresses an issue, please use the pull request title
6574
to describe the issue and mention the issue number in the pull request description. This will make sure a link back to the original issue is
@@ -105,18 +114,18 @@ tools:
105114
$ pytest --cov=. path/to/tests_for_package
106115
```
107116

108-
- No pyflakes warnings, check with:
117+
- No style warnings, check with:
109118

110119
```bash
111-
$ pip install pyflakes
112-
$ pyflakes path/to/module.py
120+
$ pip install flake8
121+
$ flake8 --ignore E402,W503 --show-source --max-line-length 100
113122
```
114123

115-
- No PEP8 warnings, check with:
124+
- No mypy (typing) issues, check with:
116125

117126
```bash
118-
$ pip install pep8
119-
$ pep8 path/to/module.py
127+
$ pip install mypy
128+
$ mypy openml --ignore-missing-imports --follow-imports skip
120129
```
121130

122131
Filing bugs
@@ -151,8 +160,8 @@ following rules before submitting:
151160
New contributor tips
152161
--------------------
153162

154-
A great way to start contributing to scikit-learn is to pick an item
155-
from the list of [Easy issues](https://github.com/openml/openml-python/issues?q=label%3Aeasy)
163+
A great way to start contributing to openml-python is to pick an item
164+
from the list of [Good First Issues](https://github.com/openml/openml-python/labels/Good%20first%20issue)
156165
in the issue tracker. Resolving these issues allow you to start
157166
contributing to the project without much prior knowledge. Your
158167
assistance in this area will be greatly appreciated by the more
@@ -175,6 +184,14 @@ information.
175184

176185
For building the documentation, you will need
177186
[sphinx](http://sphinx.pocoo.org/),
178-
[matplotlib](http://matplotlib.org/), and
179-
[pillow](http://pillow.readthedocs.io/en/latest/).
180-
[sphinx-bootstrap-theme](https://ryan-roemer.github.io/sphinx-bootstrap-theme/)
187+
[sphinx-bootstrap-theme](https://ryan-roemer.github.io/sphinx-bootstrap-theme/),
188+
[sphinx-gallery](https://sphinx-gallery.github.io/)
189+
and
190+
[numpydoc](https://numpydoc.readthedocs.io/en/latest/).
191+
```bash
192+
$ pip install sphinx sphinx-bootstrap-theme sphinx-gallery numpydoc
193+
```
194+
When dependencies are installed, run
195+
```bash
196+
$ sphinx-build -b html doc YOUR_PREFERRED_OUTPUT_DIRECTORY
197+
```

0 commit comments

Comments
 (0)