-
-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
- Loading branch information
1 parent
af01f22
commit 82d7cbf
Showing
12 changed files
with
82 additions
and
112 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 |
---|---|---|
|
@@ -20,3 +20,5 @@ src_paths = | |
cyclonedx | ||
tests | ||
typings | ||
examples | ||
tools |
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
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
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,83 +1 @@ | ||
Contributing | ||
==================================================== | ||
|
||
Pull requests are welcome, but please read these contributing guidelines first. | ||
|
||
Setup | ||
---------------------------------------------------- | ||
|
||
This project uses `poetry`_. Have it installed and setup first. | ||
|
||
To install dev-dependencies and tools: | ||
|
||
.. code-block:: | ||
poetry install --all-extras | ||
Code style | ||
---------------------------------------------------- | ||
|
||
This project uses `PEP8`_ Style Guide for Python Code. This project loves sorted imports. Get it all applied via: | ||
|
||
.. code-block:: | ||
poetry run isort . | ||
poetry run autopep8 -ir cyclonedx/ tests/ typings/ examples/ | ||
Documentation | ||
---------------------------------------------------- | ||
|
||
This project uses `Sphinx`_ to generate documentation which is automatically published to `readthedocs.io`_. | ||
|
||
Source for documentation is stored in the ``docs`` folder in `RST`_ format. | ||
|
||
You can generate the documentation locally by running: | ||
|
||
.. code-block:: | ||
cd docs | ||
pip install -r requirements.txt | ||
make html | ||
Testing | ||
---------------------------------------------------- | ||
|
||
Run all tests in dedicated environments, via: | ||
|
||
.. code-block:: | ||
poetry run tox run | ||
Sign your commits | ||
---------------------------------------------------- | ||
|
||
Please sign your commits, to show that you agree to publish your changes under the current terms and licenses of the | ||
project. We can't accept contributions, however great, if you do not sign your commits. | ||
|
||
.. code-block:: | ||
git commit --signed-off ... | ||
Pre-commit hooks | ||
---------------------------------------------------- | ||
|
||
If you like to take advantage of `pre-commit hooks`_, you can do so to cover most of the topics on this page when | ||
contributing. | ||
|
||
.. code-block:: | ||
pre-commit install | ||
All our pre-commit checks will run locally before you can commit! | ||
|
||
|
||
.. _poetry: https://python-poetry.org | ||
.. _PEP8: https://www.python.org/dev/peps/pep-0008 | ||
.. _Sphinx: https://www.sphinx-doc.org/ | ||
.. _readthedocs.io: https://cyclonedx-python-library.readthedocs.io/ | ||
.. _RST: https://en.wikipedia.org/wiki/ReStructuredText | ||
.. _pre-commit hooks: https://pre-commit.com | ||
.. mdinclude:: ../CONTRIBUTING.md |
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,4 +1,4 @@ | ||
m2r2>=0.3.2 | ||
Sphinx>=4.3.2 | ||
sphinx-autoapi>=1.8.4 | ||
sphinx-rtd-theme>=1.0.0 | ||
Sphinx>=7.2.6,<8 | ||
sphinx-autoapi>=2.1.1,<3 | ||
sphinx-rtd-theme>=1.3.0,<2 |
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