search

sporniket / ideas

My backlog of ideas, organized as a bunch of issues
0 stars 0 forks source link

Multiple sources of availability #43

Open sporniket opened 1 month ago

sporniket commented 1 month ago

Inside a project, create a file README-MIRRORS.md that will contains : 

# Mirrors of this project

**Content**
0. Preamble
1. Software forges
2. Git repositories
3. Issue trackers
4. Installable releases
5. Source tarballs
6. Exhaustive source tarballs
sporniket commented 1 month ago

For a github hosted project, the file may be seeded like this :

Mirrors of this project

Content

  1. Preamble
  2. Software forges
  3. Git repositories
  4. Issue trackers
  5. Installable releases
  6. Source tarballs
  7. Exhaustive source tarballs

Preamble

to be written : purpose of this file, definition of each section.

remainder : for each section, the first link is the primary location (exclusively used by the main development team, in other word, the authoritative reference). Other links are mirrors, i.e aims to reflects the content of the primary location. Reflection may be complete or partial, depending of circumstance (easy to replicate, automatic sync process, etc...)

Exhaustive source tarballs : tarball including the sources of the project, as well as any dependancies sources (e.g. for a python project managed with pdm : include the content of the virtual environment ; etc...) The idea is that no further source download is required. Supplemental tools MAY be required, if not part of what is usually available, but in this case, including the source of the tool MAY be recommended.

about availability through dependency manager (pypi, maven central, platformio, npm, docker hub, etc...)

Software forges