elly99 commited on
Commit
18dc5bb
·
verified ·
1 Parent(s): 9ac2fd7

Update Contributing.md

Browse files
Files changed (1) hide show
  1. Contributing.md +112 -82
Contributing.md CHANGED
@@ -1,96 +1,126 @@
 
 
 
 
1
 
2
- Grazie per il tuo interesse nel contribuire a MarCognity-AI , il framework open source dedicato alla sperimentazione dell'intelligenza artificiale riflessiva.
3
-
4
- Ogni contributo è benvenuto: codice, documentazione, test, idee e segnalazioni di problemi.
5
- MarCognity-AI non è solo un progetto tecnico: è una visione condivisa.
6
-
7
- ##Prima di iniziare
8
-
9
- Assicurati che il tuo contributo sia in linea con la visione etica e scientifica del progetto .
10
- Leggere i file README.mde LICENSEper comprendere obiettivi e vincoli.
11
- Mantenere un tono rispettoso e costruttivo in tutte le interazioni.
12
- Tipi di contributi accettati
13
- Correzioni di bug
14
- Ottimizzazione del codice
15
- Nuove funzionalità modulari (LLM, incorporamenti, metacognizione, ecc.)
16
- Traduzioni in altre lingue
17
- Segnalazioni di problemi (idee, anomalie, suggerimenti di refactoring)
18
- Contributi in formato Jupyter Notebook ( .ipynb)
19
- I quaderni sono essenziali per presentare esempi, test cognitivi e soluzioni.
20
- Puoi contribuire:
21
  ---
22
- Quaderni dimostrativi
23
- Tutorial interattivi
24
- Test per moduli cognitivi
25
- Per favore:
26
-
27
- Inizia con una cella Markdown che include titolo, scopo, autore e licenza
28
- Mantenere il quaderno pulito e ben documentato
29
- Salva il file nella notebooks/cartella
30
- Requisiti tecnici
31
-
32
- Per i moduli Python ( .py)
33
-
34
- Seguire le convenzioni di denominazione e di stile
35
- Includi docstring e commenti chiari
36
- Evitare dipendenze inutili
37
- Garantire la compatibilità con i modelli e le licenze esistenti
38
- Posizionare i file nella struttura corretta src/o marcognity/con la struttura corretta
39
  ---
40
- Per Jupyter Notebook ( .ipynb)
41
-
42
- Inizia con una cella Markdown: titolo, scopo, autore, licenza
43
- Mantenere il quaderno pulito e ben documentato
44
- Utilizzare i moduli del progetto per dimostrare la funzionalità
45
- Salva nella notebooks/cartella
46
- Cose da evitare
47
- Modifiche che consentono l'uso commerciale diretto (non consentite dal progetto)
48
- Modelli closed-source o non verificabili
49
- Contenuti o funzionalità che violano i principi etici
50
- Richieste di pull incomplete o inspiegabili
51
- Test e qualità del codice
52
- Prima di inviare un contributo, testalo attentamente per garantirne stabilità e compatibilità.
53
  ---
54
- Comunicazione
55
- Per proporre idee o discutere nuove funzionalità:
56
-
57
- Apri un problema
58
- Utilizzare la sezione Discussioni del repository
59
- Oppure commenta direttamente sotto la tua richiesta di pull
60
- Note aggiuntive e uso previsto
61
- MarCognity-AI è distribuito con licenza Apache 2.0 .
62
- Puoi utilizzarlo, modificarlo e condividerlo liberamente per progetti di ricerca, istruzione e open source , a condizione che venga preservata l'attribuzione originale.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
63
  ---
64
- Diritti concessi da Apache 2.0:
65
- Utilizzare, modificare e distribuire il codice
66
- Uso commerciale del codice (con eccezioni per modelli specifici)
67
- Possibilità di biforcare e creare versioni derivate
68
- Questo progetto include prompt originali e codice Python sviluppato da Elena Marziali.
69
- Tutti i contenuti sono rilasciati con licenza Apache 2.0.
70
- È vietata la rimozione del copyright o la ridistribuzione senza attribuzione.
 
71
  ---
72
- Ringraziamenti
73
- Ogni contributo accettato sarà menzionato nel changelog e, se significativo, nella sezione autori.
74
- Crediamo nella collaborazione trasparente e nel riconoscimento basato sul merito.
75
 
76
- ## 🔗 Codice sorgente completo
77
 
78
- Il codice Python del framework, con la cartella `src/`, è disponibile su GitHub.
79
 
80
- Per esplorare la logica interna, i moduli cognitivi e le funzioni personalizzate, consulta direttamente il repository.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
81
 
82
- Se riutilizzi o modifichi questo progetto, ti preghiamo di citare l'autore originale:
83
 
84
- Basato su MarCognity-AI creato da [Elena Marziali o elenamarziali]
85
- Distribuito sotto licenza Apache 2.0
86
- Include modelli soggetti a licenze specifiche (ad esempio, LLaMA 4 – Meta Community License)
87
 
88
- Puoi includere questa citazione nel tuo articolo, documento o presentazione.
89
- Ogni riferimento è apprezzato e contribuisce ad aumentare la visibilità del progetto.
90
 
91
- Marziali, E. (2025). MarCognity-AI: quadro cognitivo per LLM . Repository GitHub. https://github.com/elenamarziali/MarCognity-AI.git
92
 
93
- Supporto e contatti
94
- Hai domande, dubbi o vuoi proporre una collaborazione più ampia?
95
- Apri un problema o scrivi nella sezione Discussioni.
96
- Ogni voce è ascoltata.
 
1
+ Thank you for your interest in contributing to **MarCognity-AI**, the open-source framework dedicated to experimentation in reflective artificial intelligence.
2
+
3
+ Every contribution is welcome: code, documentation, tests, ideas, and issue reports.
4
+ MarCognity-AI is not just a technical project — it's a shared vision.
5
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
6
  ---
7
+
8
+ ## Before You Begin
9
+
10
+ - Ensure your contribution aligns with the project's **ethical and scientific vision**.
11
+ - Read the `README.md` and `LICENSE` files to understand goals and constraints.
12
+ - Maintain a respectful and constructive tone in all interactions.
13
+
 
 
 
 
 
 
 
 
 
 
14
  ---
15
+
16
+ ## Accepted Contribution Types
17
+
18
+ - Bug fixes
19
+ - Code optimization
20
+ - New modular features (LLMs, embeddings, metacognition, etc.)
21
+ - Translations into other languages
22
+ - Issue reports (ideas, anomalies, refactoring suggestions)
23
+
 
 
 
 
24
  ---
25
+
26
+ ## Contributions in Jupyter Notebook Format (`.ipynb`)
27
+
28
+ Notebooks are essential for showcasing examples, cognitive tests, and walkthroughs.
29
+ You can contribute:
30
+
31
+ - Demonstration notebooks
32
+ - Interactive tutorials
33
+ - Tests for cognitive modules
34
+
35
+ Please:
36
+
37
+ - Start with a Markdown cell including title, purpose, author, and license
38
+ - Keep the notebook clean and well-documented
39
+ - Save the file in the `notebooks/` folder
40
+
41
+ ---
42
+
43
+ ## Technical Requirements
44
+
45
+ ### For Python Modules (`.py`)
46
+ - Follow naming and style conventions
47
+ - Include clear docstrings and comments
48
+ - Avoid unnecessary dependencies
49
+ - Ensure compatibility with existing models and licenses
50
+ - Place files in `src/` or `marcognity/` with proper structure
51
+
52
+ ### For Jupyter Notebooks (`.ipynb`)
53
+ - Begin with a Markdown cell: title, purpose, author, license
54
+ - Keep the notebook clean and well-documented
55
+ - Use project modules to demonstrate functionality
56
+ - Save in the `notebooks/` folder
57
+
58
  ---
59
+
60
+ ## Things to Avoid
61
+
62
+ - Changes that enable direct commercial use (not permitted by the project)
63
+ - Closed-source or unverifiable models
64
+ - Content or features that violate ethical principles
65
+ - Incomplete or unexplained Pull Requests
66
+
67
  ---
 
 
 
68
 
69
+ ## Testing and Code Quality
70
 
71
+ Before submitting a contribution, please test it thoroughly to ensure stability and compatibility.
72
 
73
+ ---
74
+
75
+ ## Communication
76
+
77
+ To propose ideas or discuss new features:
78
+
79
+ - Open an **Issue**
80
+ - Use the **Discussions** section of the repository
81
+ - Or comment directly under your Pull Request
82
+
83
+ ---
84
+
85
+ ## Additional Notes and Intended Use
86
+
87
+ MarCognity-AI is distributed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
88
+ You are free to use, modify, and share it for **research, education, and open-source projects**, provided the original attribution is preserved.
89
+
90
+ ### Rights Granted by Apache 2.0:
91
+ - Use, modify, and distribute the code
92
+ - Commercial use of the code **(with exceptions for specific models)**
93
+ - Ability to fork and create derivative versions
94
+
95
+ This project includes original prompts and Python code developed by Elena Marziali.
96
+ All content is released under the Apache 2.0 license.
97
+ Removing copyright or redistributing without attribution is prohibited.
98
+
99
+ ---
100
+
101
+ ## Acknowledgments
102
+
103
+ Every accepted contribution will be recognized in the changelog and, if significant, in the authors section.
104
+ We believe in transparent collaboration and merit-based recognition.
105
+
106
+ If you reuse or modify this project, please cite the original author:
107
+
108
+ > Based on MarCognity-AI created by [Elena Marziali or elenamarziali]
109
+ > Distributed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0)
110
+ > Includes models subject to specific licenses (e.g., LLaMA 4 – Meta Community License)
111
+
112
+ You may include this citation in your paper, article, or presentation.
113
+ Every reference is appreciated and helps increase the project's visibility.
114
+
115
+ > Marziali, E. (2025). *MarCognity-AI: Cognitive Framework for LLMs*. GitHub Repository. https://github.com/elenamarziali/MarCognity-AI.git
116
+
117
+ ---
118
 
119
+ ## Support and Contact
120
 
121
+ Have questions, concerns, or want to propose a broader collaboration?
122
+ Open an Issue or write in the Discussions section.
123
+ Every voice is heard.
124
 
 
 
125
 
 
126