🧠 D: DOCUMENT — Problem & Opportunity
What is the problem, limitation, or opportunity? Why does this matter for SKaiNET?
Explain the context in clear terms:
- What functionality is missing or insufficient?
- Why is this important now?
- Who benefits (users, developers, researchers)?
- What is the high-level goal of this proposal?
The project is missing a standardized why to implement licencing. This is important now because it is important for users, especially companies, to know what licence a file has and who owns the copyright. The high-level goal is to add licencing information - which is readable by humans and machines - to all files.
Summary (1–2 sentences):
The issue addresses the licencing issue by proposing to use the REUSE standard, and is hence a part of issue #594.
🔍 A: ASSESS — Feasibility & Impact
Provide an evaluation of the proposal. Address the following:
✔️ Feasibility
- Is the feature straightforward to implement?
- Are there architectural constraints?
Adding REUSE is straighforward to add to the repository. The architecture of the software remains untouched.
✔️ Expected Impact
- How does this improve SKaiNET?
- Does it unlock new capabilities?
Adding REUSE impacts SKaiNET positively because users can be certain about the licencing situation of the project, and the licencing information is processable by machines.
✔️ Risks / Constraints
- Technical challenges?
- Numerical stability concerns?
- API consistency?
Not applicable.
✔️ Dependencies
- Does this rely on an existing SKaiNET module?
- Does it require third-party libraries or standards?
The change requires third party libraries and standards, in particular the REUSE API and the REUSE Compliance Check action.
📚 R: RESEARCH — What Must Be Understood First?
Document research tasks or open questions that must be answered before implementation:
Research Tasks
- [] Review existing frameworks (PyTorch, JAX, TensorFlow, etc.)
- [] Identify relevant algorithms or formulas
- [] Compare design patterns for modularity
- [] Investigate numerically stable or optimized variants
- [] Check for relevant academic papers or benchmarks
Not applicable.
Open Questions
List unknowns that contributors should discuss or resolve.
Not applicable.
🛠️ C: CODE — Implementation Plan
Break down actionable steps required to deliver this feature:
Development Tasks
Acceptance Criteria
💬 Additional Notes
Add diagrams, pseudo-code, references, or implementation notes that may help future contributors.
🧠 D: DOCUMENT — Problem & Opportunity
What is the problem, limitation, or opportunity? Why does this matter for SKaiNET?
Explain the context in clear terms:
The project is missing a standardized why to implement licencing. This is important now because it is important for users, especially companies, to know what licence a file has and who owns the copyright. The high-level goal is to add licencing information - which is readable by humans and machines - to all files.
Summary (1–2 sentences):
🔍 A: ASSESS — Feasibility & Impact
Provide an evaluation of the proposal. Address the following:
✔️ Feasibility
Adding REUSE is straighforward to add to the repository. The architecture of the software remains untouched.
✔️ Expected Impact
Adding REUSE impacts SKaiNET positively because users can be certain about the licencing situation of the project, and the licencing information is processable by machines.
✔️ Risks / Constraints
Not applicable.
✔️ Dependencies
The change requires third party libraries and standards, in particular the REUSE API and the REUSE Compliance Check action.
📚 R: RESEARCH — What Must Be Understood First?
Document research tasks or open questions that must be answered before implementation:
Research Tasks
Not applicable.
Open Questions
🛠️ C: CODE — Implementation Plan
Break down actionable steps required to deliver this feature:
Development Tasks
Acceptance Criteria
💬 Additional Notes