You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Rewrite Entire API
* Add MyPy
* Overhaul API and Documentation
* Add index.rst files.
* Add doc requires to RTD
* Add changelog fragments and minor changes.
* Add opencollective funding link to repo
* Change description
* Explicit include for py.typed file
Copy file name to clipboardExpand all lines: CHANGELOG.rst
+23Lines changed: 23 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,29 @@ This file is updated every release since v1.0.0 with the use of towncrier from t
4
4
5
5
.. towncrier release notes start
6
6
7
+
Openskill 5.0.0 (2023-07-21)
8
+
============================
9
+
10
+
Breaking Changes
11
+
----------------
12
+
13
+
- All top level functions are now methods that must be called from model once it's been initialized. (`#101 <https://github.com/OpenDebates/openskill.py/issues/101>`_)
14
+
15
+
16
+
Features
17
+
--------
18
+
19
+
- Add PEP-517 and PEP-518 compliance. (`#82 <https://github.com/OpenDebates/openskill.py/issues/82>`_)
20
+
- Everything is strictly type hinted to let you use your IDE's autocomplete features. (`#101 <https://github.com/OpenDebates/openskill.py/issues/101>`_)
21
+
22
+
23
+
Documentation Improvements
24
+
--------------------------
25
+
26
+
- All functions, methods and classes have docstrings now. There are also LaTeX equations in
27
+
docstrings when necessary. (`#101 <https://github.com/OpenDebates/openskill.py/issues/101>`_)
All methods and functions must be in snake_case and not camelCase. All
9
+
code must also be formatted with `black` and it's default settings.
10
+
11
+
## Documentation
12
+
13
+
You must document any and all objects, modules, packages and namespaces you define.
14
+
You must use also use the default [sphinx format](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html#the-sphinx-docstring-format) for docstrings.
15
+
16
+
## Tests
17
+
18
+
You are responsible for writing tests for any code you contribute. We use
19
+
[pytest](https://docs.pytest.org/en/stable/) for testing. Once you've written
20
+
your tests, you should run tox to ensure that your tests pass on all supported
21
+
python versions.
22
+
23
+
## Towncrier
24
+
25
+
To aid with the generation of `CHANGELOG.rst` as well as the releases
26
+
changelog we use towncrier.
27
+
28
+
You will need to install towncrier and openskill.py from source before
29
+
making changelog additions. You can learn about how to install the package
30
+
for contribution in the [documentation](https://openskill.me/en/stable/installation.html).
31
+
32
+
For every pull request made to this project, there should be a short
33
+
explanation of the change under changes/ with the following format:
34
+
`{pull_request_number}.{type}.rst`,
35
+
36
+
Possible types are:
37
+
38
+
- breaking: Signifying a backwards incompatible change.
39
+
- feature: Signifying a new feature.
40
+
- bugfix: Signifying a bugfix.
41
+
- doc: Signifying a documentation improvement.
42
+
- deprecation: Signifying a deprecation or removal of public API.
43
+
44
+
For changes that do not fall under any of the above cases, please
45
+
specify the lack of the changelog in the pull request description so
46
+
that a maintainer can skip the job that checks for newly added
47
+
fragments.
48
+
49
+
Best way to create the fragments is to run towncrier create
50
+
`{pull_request_number}.{type}.rst` after creating the pull request, edit
51
+
the created file and committing the changes.
52
+
53
+
Multiple fragment types can be created per pull request if it covers
54
+
multiple areas.
55
+
56
+
## Pull Requests
57
+
58
+
We follow [Github Flow](https://guides.github.com/introduction/flow/) as
59
+
our workflow when creating pull requests. It is a neater and easier way
60
+
to manage changes. You are also responsible for writing tests(where
61
+
applicable) if you are contributing to a core module. If we see an area
62
+
of code that requires tests, then we will not accept the PR until you
63
+
write a test for that area of code. Tests ensure long term stability.
64
+
65
+
Also note that there are CI checks in place. If any automated tests
66
+
fail, please rework and resubmit your PR.
67
+
68
+
## Credit Yourself
69
+
70
+
Remember to follow this
71
+
[guide](https://allcontributors.org/docs/en/bot/usage) to add yourself
72
+
to the list of [contributors](https://github.com/OpenDebates/openskill.py/blob/main/CONTRIBUTORS.md).
0 commit comments