... | ... | @@ -9,7 +9,7 @@ Do not include these optional extensions in the slug. |
|
|
|
|
|
Please **carefully choose a project title**, as it could cause some problems if it is changed later on (and sometimes it cannot be changed anymore). Ensure the **project slug** is a string that works easily as a folder/file name for your own convenience (no spaces and characters that need quoting, etc). Also, consider if the project should be part of an **existing group**, a **new group**, or under **your account**. Any of this can be changed later on, if suitable, but ideally, you get this right from the start. If unsure, create a private project under your user account and decide later what to do with it. Initially, it may be best to make your project **private** or **internal** before being ready to be published as a public project.
|
|
|
|
|
|
When the project is set up, make sure you **complete all the other information** of the project in the project settings, including the **general** section: description, avatar, topics, features, badges, service desk; the CI/CD setup; and other parts of the settings that may apply, in particular when the project is more established. We suggest not to enable any features for the project you are not using (yet). Make sure your project has got a README.md file with a suitable description and a LICENSE file, choosing a licensing option. You can provide detailed documentation of your project in the wiki (this is in a git archive, so it can be handled like the main repository). Projects that are insufficiently documented and whose purpose cannot be clearly identified or whose setup is causing problems for the site may be deleted.
|
|
|
When the project is set up, make sure you **complete all the other information** of the project in the project settings, including the **general** section: description, avatar, topics, features, badges, service desk; the CI/CD setup; and other parts of the settings that may apply, in particular when the project is more established. We suggest not to enable any features for the project you are not using (yet). Make sure your project has got a `README.md` file with a suitable description and `LICENSE(S)` files, choosing a licensing option (preferably make sure you are [REUSE](https://reuse.software/) compliant). You can provide detailed documentation of your project in the wiki (this is in a git archive, so it can be handled like the main repository). Projects that are insufficiently documented and whose purpose cannot be clearly identified or whose setup is causing problems for the site may be deleted.
|
|
|
|
|
|
When setting up the project, keep in mind that **large files** and especially binary files should be added via [git LFS](https://git-lfs.github.com/) to avoid the git repository becomes inefficient. **Large data collections** are ideally separated into related projects in a (sub-)group, where each project contains one consistent set of data that can be released together, and no smaller unit would make sense to release on its own (as usual).
|
|
|
|
... | ... | |