Skip to content

Commit 2502c78

Browse files
Merge pull request #45 from Electa-Git/repair/revert-direct-v0.2.0
revert(release): remove direct v0.2.0 preparation
2 parents 0d88fdd + 018c10c commit 2502c78

282 files changed

Lines changed: 31211 additions & 33361 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.JuliaFormatter.toml

Lines changed: 0 additions & 9 deletions
This file was deleted.

.gitattributes

Lines changed: 0 additions & 1 deletion
This file was deleted.
Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
name: "Release approval request"
2+
description: "Validation checklist before public release"
3+
title: "Release approval request"
4+
labels: ["release-approval"]
5+
assignees:
6+
- amaurigmartins
7+
8+
body:
9+
- type: input
10+
id: repository_name
11+
attributes:
12+
label: "Repository name"
13+
description: "Select the repository being released"
14+
validations:
15+
required: true
16+
17+
- type: input
18+
id: version_tag
19+
attributes:
20+
label: "Version tag"
21+
description: "Version being released (must follow semantic versioning pattern vX.Y.Z)"
22+
placeholder: "v1.2.3"
23+
validations:
24+
required: true
25+
26+
- type: markdown
27+
attributes:
28+
value: |
29+
## 1. Intellectual Property (IP) and Legal Clearance
30+
Complete all items before requesting approval.
31+
32+
- type: checkboxes
33+
id: ip_legal
34+
attributes:
35+
label: "IP and Legal Requirements"
36+
options:
37+
- label: "Written consent secured from faculty advisor or PI"
38+
required: true
39+
- label: "Software disclosure submitted to tech transfer/IP office"
40+
required: true
41+
- label: "Funding/sponsorship contracts reviewed for restrictions or obligations"
42+
required: true
43+
- label: "Written consent secured from all co-developers and collaborators"
44+
required: true
45+
- label: "Verified no active or pending patents are compromised by open release"
46+
required: true
47+
- label: "Verified absence of sensitive data (personal, confidential, regulated tech)"
48+
required: true
49+
- label: "Third-party licenses audited and documented to confirm compatibility with the repository"
50+
required: true
51+
- label: "All findings and products of the codebase being open-sourced have been published/accepted for publication with scientific journals"
52+
required: true
53+
54+
- type: markdown
55+
attributes:
56+
value: |
57+
## 2. Code Quality and Basic QA
58+
59+
- type: checkboxes
60+
id: code_quality
61+
attributes:
62+
label: "Code Quality Requirements"
63+
options:
64+
- label: "Codebase cleaned: no credentials, passwords, API keys, sensitive URLs, or debug code"
65+
required: true
66+
- label: "Out-of-the-box functionality confirmed in a clean environment"
67+
required: true
68+
- label: "Reproducibility ensured: scripts or datasets included to reproduce main results"
69+
required: true
70+
- label: "Dependencies clearly documented (requirements.txt, compiler info, etc.)"
71+
required: true
72+
- label: "Basic tests or validation scripts included demonstrating key functionality"
73+
required: true
74+
- label: "Peer or self-review performed for code readability and usability"
75+
required: true
76+
77+
- type: markdown
78+
attributes:
79+
value: |
80+
## 3. Documentation and Licensing
81+
82+
- type: checkboxes
83+
id: documentation
84+
attributes:
85+
label: "Documentation Requirements"
86+
options:
87+
- label: "Comprehensive README.md created with clear purpose, installation and usage instructions"
88+
required: true
89+
- label: "CHANGELOG.md created following proper standards (Keep a Changelog)"
90+
required: true
91+
- label: "Citation instructions provided (CITATION.cff, DOI links, publication references)"
92+
required: true
93+
- label: "Appropriate LICENSE.md file attached at repository root"
94+
required: true
95+
- label: "Funding agencies, institutional support, and contributors properly acknowledged"
96+
required: true
97+
- label: "Contributing guidelines included for external collaborators (if applicable)"
98+
required: false
99+
100+
- type: markdown
101+
attributes:
102+
value: |
103+
## 4. Repository Finalization and Public Release
104+
105+
- type: checkboxes
106+
id: finalization
107+
attributes:
108+
label: "Repository Finalization Requirements"
109+
options:
110+
- label: "Repository structure clearly organized (src/, examples/, docs/, etc.)"
111+
required: true
112+
- label: "Final pre-release sanity check performed (installation from scratch, test examples)"
113+
required: true
114+
- label: "Release clearly tagged and versioned (e.g., v1.0.0) with release notes"
115+
required: true
116+
- label: "Repository ready to be set to public visibility"
117+
required: true
118+
- label: "Release announcement prepared for internal and external channels"
119+
required: true
120+
- label: "Repository archived with DOI (optional, via Zenodo)"
121+
required: false
122+
123+
- type: textarea
124+
id: additional_notes
125+
attributes:
126+
label: "Additional Notes"
127+
description: "Provide any additional context or special considerations"
128+
placeholder: "Add any relevant information or clarifications here..."
129+
validations:
130+
required: false
131+
132+
- type: input
133+
id: institutional_email
134+
attributes:
135+
label: "Institutional email"
136+
description: "Provide your university/institutional email"
137+
placeholder: "researcher.name@kuleuven.be"
138+
validations:
139+
required: true
140+
141+
- type: markdown
142+
attributes:
143+
value: |
144+
## Declaration
145+
146+
By submitting this form, I confirm that all required checks have been completed and this software is ready for public release under the institution standards.

.github/OSS_PUBLISH_CHECKLIST.md

Lines changed: 0 additions & 49 deletions
This file was deleted.

0 commit comments

Comments
 (0)