We should add a CITATION file to the repository to help users correctly cite the Salam software

https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files

Yes, adding a citation file—specifically a CITATION.cff file using the Citation File Format (CFF)—to the SalamLang/Salam GitHub repository would be highly beneficial.

1. Easier for Users to Cite Correctly

• GitHub Integration: When a CITATION.cff file is present in the root of a GitHub repository, GitHub automatically displays a "Cite this repository" link in the sidebar .
• Automatic Formatting: Clicking this link provides the citation information in common formats like APA and BibTeX, which users can easily copy and paste into academic papers, documentation, or other materials.
• Encourages Proper Attribution: This removes the guesswork for users, ensuring they attribute Salam correctly, which is vital for recognizing the work of the maintainers and contributors.

2. Increased Recognition and Visibility

• Formal Recognition: For open-source projects, especially those that may be used in academic or research-related contexts, a citation file formalizes the process of receiving academic credit.
• Zenodo Integration: CFF files integrate seamlessly with services like Zenodo. By connecting the Salam GitHub repository to Zenodo, every new release can be automatically archived and assigned a Digital Object Identifier (DOI). A DOI is a permanent, persistent identifier that makes the software a formally citable research output.

3. Machine-Readable Metadata

• Interoperability: The CFF is designed to be both human- and machine-readable. Tools and services (like Zenodo, Zotero reference manager, and others) can automatically parse the file to extract critical metadata, such as:
  • Authors/Maintainers
  • Title
  • Version
  • Date released
  • DOI (if assigned)

In summary, a CITATION.cff file is a small addition that significantly improves the discoverability, traceability, and credit/recognition for the Salam project and its contributors.