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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
Contributing
============
Contributions are welcome, and they are greatly appreciated!
Types of contributions
----------------------
There are many ways you can contribute.
Report bugs
~~~~~~~~~~~
You're welcome to report bugs at
`GitHub Issues <https://github.com/authlib/joserfc/issues>`_.
Before reporting a bug, please verify your bug against the latest
code in ``main`` branch.
When reporting a bug, please including:
- Your operating system name and version.
- Your Python version.
- Details to reproduce the bug.
Submit fixes
~~~~~~~~~~~~
Once you found a bug that you can fix, you're welcome
to submit your pull request.
Please follow our `git commit conventions <https://www.conventionalcommits.org/en/v1.0.0/>`_.
Improve documentation
~~~~~~~~~~~~~~~~~~~~~
Everyone wants a good documentation. There may be mistakes
or things missing in the documentation, you're welcome to
help us improving the documentation.
.. _development:
Development
-----------
Once you cloned ``joserfc``'s source code, you can setup a development
environment to work on.
venv
~~~~
I strongly suggest you create a virtual environment with ``venv``:
.. code-block:: shell
python -m venv .venv
source .venv/bin/active
Install
~~~~~~~
Then install the Python requirements for development:
.. code-block:: shell
pip install -r requirements-dev.txt
Run tests
~~~~~~~~~~
Once you made some code changes, you can add your test
case in the ``tests`` folder, then verify it with:
.. code-block:: shell
pytest
Next
----
.. toctree::
structure
translation
authors
sponsors
|
