Sharing incomplete code (source files) for a Program already archived on FigShare

[PollenAnupama]

Select Topic Area

Question

Body

All the code or source files are in one zip file that I have uploaded to the repository I created. Is this the best way to share? The code is is C/ C++ and it is partial because of copyright restrictions

[Aqib121201]

If you only need to share partial code, uploading a zip file works, but it’s not the best way. It’s better to upload the source files directly to the repository instead of bundling them. That way, others can browse, view, or cite individual files without downloading everything.
Since your code is already archived on FigShare, you can keep that as the main reference and link to it in your repo’s README. In your repo, include only the non restricted files and clearly note that the rest are excluded for copyright reasons.

This keeps your project transparent and easier for others to use or reference.

If this helps, mark the answer as helpful so others can find it.

[PollenAnupama]

Thank you very much. that is helpful. The files have extensions CPP and H. I can extract them and upload them using the same directory structure as in the Zip file though I am unable to open them myself.

[moxyvv]

Zipping code files for a repository is fine but not ideal. For partial C/C++ code with copyright restrictions, consider:

1. Repository Structure: Instead of one zip, organize files in a clear directory structure within the repository. Use folders for different modules or components to improve navigation.

2. Selective Sharing: Share only non-sensitive code directly in the repository. For copyrighted parts, include placeholders or documentation explaining the omitted sections without violating restrictions.

3. Documentation: Add a README with build instructions, dependencies, and notes on the partial code, clarifying what’s included and why parts are missing.

4. Alternative Formats: If zipping is necessary, ensure the zip is well-documented with a manifest file listing contents and their purpose. However, unzipped files with version control (e.g., Git) are preferred for collaboration and transparency.

5. Access Control: If the code is sensitive, use a private repository with controlled access instead of public sharing.

Directly committing files to the repository with proper documentation is generally better than a single zip for accessibility and version control.

[PollenAnupama]

Thank you very much. that is helpful. The files have extensions CPP and H. I can extract them and upload them using the same directory structure as in the Zip file though I am unable to open them myself.