Contributing.md
@thehabes is already working on this.
Since Nov 11, 2022.
Assessment
This issue has not been assessed yet.
Description
A markdown page for those interested in contributing to T-PEN. The main use case is the Open Source Center at SLU through which students can contribute to open source projects.
The goal is to make it possible for a new programmer to have a place to start in the code. From a top level, I think this forks into to two main paths of entry, Interfaces and Servlets.
-
T-PEN's greatest contribution to the internet is the Linked Open Data it produces, stores and makes available. The T-PEN 2.8 distribution does this with Java Classes, a bulk of which are HTTPServlets mapped by a web.xml document Spring and Struts style. The data is stored in a MySQL database. The proper data is queried for by a Servlet or Class then reconfigured as JSON-LD by that class, then sent on in the body of a HTTPServletResponse to clients.
-
T-PEN's greatest use case is Line by Line Transcription of Manuscripts. The response from the Java servlets is processed by Javascript middleware that builds it into a HTML User Interface. Users can set up projects based off of particular manuscripts then build teams around those projects for transcribing all pertinent lines on pertinent pages. Project Management, User Management, Admin Reports, and Transcription interfaces exist to give users the controls necessary to do all this. Those interfaces interact with existing Servlets to take data from a user in the interface to the MySQL database, and then back when necessary.
I believe trying to represent both of those forks under one specific diagram may be too difficult. I think we need individual diagrams for each of these forks to properly guide a new developer to where they should begin in the code.
- Dominant language
- Java
- Stars
- 4
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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 CenterForDigitalHumanities/TPEN28
-
bug IIIF interoperability
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 3/5 1-2 days Newbie friendliness 38/100
-
interoperability
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
interoperability
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
interoperability
Difficulty 5/5 Over a week Newbie friendliness 25/100
All issues in CenterForDigitalHumanities/TPEN28
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
hierynomus/sshj#1070 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
quarkiverse/quarkus-jooq#324 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
apache/rocketmq-dashboard#7039 ·
Maintainers usually reply within 3 days
-
pdfium-drift
Difficulty 1/5 Under an hour Newbie friendliness 82/100
Stirling-Tools/JPDFium#176 ·
Maintainers usually reply within 1 day
-
Guidelines: redundant use cases, stale dev bundle after snapshot bumps, looking up snapshot APIPossibly taken @totally-not-ai claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
vaadin/use-cases#441 · 1 comment ·
Maintainers usually reply within 1 day