server: Update and expand READMEs
Maintainers usually reply within 4 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Start by reviewing the project-level README.md, the README.md files under server, and the separate ./server/example_configurations structure. Compare their current instructions with the server layout and determine what information is missing for running it; done means the README files consistently document the updated structure and run instructions.
Written by the indexing model from the issue text.
Description
Previously, we adapted our server project structure and with that, split our project-level README.md into smaller parts, in preparation for the separate ./server/example_configurations.
Now we should make sure that the README.md files are up to date and expand them were necessary with new information on how to run it.
- Dominant language
- Python
- Stars
- 104
- Forks
- 56
- Avg merge
- 12d 13h
- Merged PRs (30d)
- 5
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from eclipse-basyx/basyx-python-sdk
-
README CI badge is brokenPossibly taken A pull request linked to this issue is open or already merged. Openbug documentation
Difficulty 1/5 Under an hour Newbie friendliness 85/100
eclipse-basyx/basyx-python-sdk#656 ·
Maintainers usually reply within 4 days
-
bug server Specification
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
eclipse-basyx/basyx-python-sdk#655 ·
Maintainers usually reply within 4 days
-
bug sdk
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
eclipse-basyx/basyx-python-sdk#634 · 3 comments ·
Maintainers usually reply within 4 days
-
enhancement server
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
eclipse-basyx/basyx-python-sdk#632 ·
Maintainers usually reply within 4 days
-
bug high priority
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
eclipse-basyx/basyx-python-sdk#631 ·
Maintainers usually reply within 4 days
All issues in eclipse-basyx/basyx-python-sdk
Similar issues
-
good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
btclib-org/btclib-node#1955 ·
Maintainers usually reply within 1 day
-
documentation v0.9.2
Difficulty 2/5 Half a day Newbie friendliness 72/100
khuisman/mcp-gee-sweet#1033 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
ossf/cve-bin-tool#5966 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 2 days
-
write_iceberg ignores the table's write.parquet.compression-codec propertyPossibly taken @YuangGao claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Eventual-Inc/Daft#7606 ·
Maintainers usually reply within 1 day