Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
silkaj
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Terraform modules
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
clients
python
silkaj
Commits
8bf7ff86
Commit
8bf7ff86
authored
4 years ago
by
Moul
Browse files
Options
Downloads
Patches
Plain Diff
[doc] contributing: Add § to suggest to read used modules docs
parent
e41e36fa
No related branches found
No related tags found
1 merge request
!180
README and CONTRIBUTING enhancements
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
CONTRIBUTING.md
+10
-1
10 additions, 1 deletion
CONTRIBUTING.md
with
10 additions
and
1 deletion
CONTRIBUTING.md
+
10
−
1
View file @
8bf7ff86
...
...
@@ -35,6 +35,15 @@ Use DuniterPy as a [path dependency](https://python-poetry.org/docs/versions/#pa
poetry add ../duniterpy
```
### Developing with modules
Silkaj is using Python modules which shape kind of a framework.
Please read their documentations on how to use them the best possible.
-
[
DuniterPy
](
https://clients.duniter.io/python/duniterpy/index.html
)
: Autogenerated documentation.
-
Feel free to contribute upstream to share the code with other Python programs
-
[
Click
](
https://click.palletsprojects.com/#documentation
)
-
[
Pendulum
](
https://pendulum.eustace.io/docs/
)
-
[
texttable
](
https://github.com/foutaise/texttable/#documentation
)
## Formatting
We are using
[
Black
](
https://github.com/python/black
)
formatter tool.
To have Black installed in your Poetry virtualenv, you will need Python v3.6 or greater.
...
...
@@ -112,7 +121,7 @@ The `--extra-index-url` is used to retrieve dependencies packages from the offic
-
Build
-
Tests on supported Python versions:
-
Installation
-
Pytest
for v3.6, 3.7, and 3.8
-
Pytest
on Python supported versions
-
PyPI distribution
-
test
-
stable
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment