Skip to content
@openlab-test

openlab-test

CERN IT-GOV-INN Made at CERN! Made at CERN! Made at CERN!

This is the CERN innovation test page and here the instructions to get the best repository ever!

Project name, project webpage and project GitHub repository

  • CERN Science for Open Data (CS4OD): webpage and repository

  • Check if there already exists a respository associated to your project

Procedure to create a new remote repository in GitHub

  • click on new
  • add Repository name
  • add Description. Description must be the project's full name
  • be sure the repository is set to Private
  • flag Add a README.md file,
  • flag Add .gitignore and choose the desired programming language
  • flag Choose a license and choose the desired license (choose MIT License if unknown)
  • Create repository
  • add repository topic: procedure. Choose between:
    • ML (classical machine learning)
    • QML (quantum machine learning)
    • QTI (quantum technology initiative)
    • ST (classical statistics)
  • use main branch for production-ready state only
  • create develop branch for the latest delivered development changes for the next release
  • create your development branch where each contributor works on a daily basis Use correct branching methods for a clean GitHub tree (docs and example)

See as an example of a ready to public repositry here. Details about README, CODE and HOW TO MAKE IT PUBLIC follow:

Requirements for the README

Full description of the project

  • Description of the project
  • How to install
    • definition of virtual environment (anaconda/venv) used
    • instruction to install the package (requirements.txt or setup.cfg etc)
    • instruction how to run the code
  • Quick start: minimal working example / tutorials / demos

Requirements for the CODE

  • requirements.txt or environment.yaml(for conda) or setup.cfg + pyproject.toml or setup.py(setuptools)
  • src/packagename folder with source files
  • formatting: production code must be formatted with Black
  • function annotations: augment all functions and modules with dosctrings

Requirements before promoting the project from private to public

  • citation policy: how to use and cite the code (e.g. BibTex reference)

Popular repositories

  1. test-templates test-templates Public

    Repository containing requirements and templates

  2. test-repo test-repo Public

    Test topics in repo

  3. .github .github Public

Repositories

Showing 3 of 3 repositories

People

This organization has no public members. You must be a member to see who’s a part of this organization.

Top languages

Loading…

Most used topics

Loading…