enac-it4r-repo

Template with licences / github templates and contributing processes

https://github.com/epfl-enac/enac-it4r-repo

Science Score: 52.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
    Organization epfl-enac has institutional domain (enac.epfl.ch)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.6%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Template with licences / github templates and contributing processes

Basic Info
  • Host: GitHub
  • Owner: EPFL-ENAC
  • License: gpl-3.0
  • Language: Shell
  • Default Branch: main
  • Size: 166 KB
Statistics
  • Stars: 5
  • Watchers: 5
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Created over 3 years ago · Last pushed 8 months ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

enac-it4r-repo

Template with licences / github templates and contributing processes

For New Repositories

If you're setting up a new repository based on this template:

  1. First-time setup:

bash make setup

This will run an interactive script to configure your repository with project-specific details.

  1. Regular development setup: bash make install This installs dependencies and sets up git hooks.

For Template Development

To set up the development environment and git hooks for working on this template itself, run:

bash make install

This will install npm dependencies and configure git hooks using Lefthook.

Available Commands

  • make setup - For new repositories: Interactive setup from template
  • make install - Install dependencies and set up git hooks
  • make clean - Clean node_modules and package-lock.json
  • make uninstall - Remove git hooks and clean dependencies
  • make help - Show available commands

Todo when setting up your github repo

  • [ ] Replace { YOUR-REPO-NAME } in all files by the name of your repo
  • [ ] Replace { YOUR-LAB-NAME } in all files by the name of your lab (.e.G epfl-cryos cf .github/workflows/deploy.yml)
  • [ ] Replace assignees: githubusernameassignee by the github handle of your lead dev
  • [ ] Modifiy or remove the CITATION.cff file.
  • [ ] ADD/REMOVE .github/workflows/release-please.yml depending on your proejct.
    • [ ] Add token for the github action secrets called: MYRELEASEPLEASE_TOKEN

Optional TODOs

  • If you created a repo outstide the organization EPFL-ENAC, please replace every instances
  • Modify .github/.copilot-instructions.md if need be
  • Check if you need all the labels: https://github.com/EPFL-ENAC/{ YOUR-REPO-NAME }/labels
  • Create your first milestone: https://github.com/EPFL-ENAC/{ YOUR-REPO-NAME }/milestones
  • Protect your branch if you're a pro user: https://github.com/EPFL-ENAC/{ YOUR-REPO-NAME }/settings/branches
  • Activate discussion

Helpful links

Owner

  • Name: EPFL ENAC
  • Login: EPFL-ENAC
  • Kind: organization
  • Location: Lausanne, Switzerland

EPFL, School of Architecture, Civil and Environmental Engineering

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: "Lisa"
    given-names: "Mona"
    orcid: "https://orcid.org/0000-0000-0000-0000"
  - family-names: "Bot"
    given-names: "Hew"
    orcid: "https://orcid.org/0000-0000-0000-0000"
title: "My Research Software"
version: 2.0.4
doi: 10.5281/zenodo.1234
date-released: 2017-12-18
url: "https://github.com/github/linguist"

GitHub Events

Total
  • Issues event: 2
  • Issue comment event: 2
  • Push event: 6
  • Create event: 1
Last Year
  • Issues event: 2
  • Issue comment event: 2
  • Push event: 6
  • Create event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • guilbep (1)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

package.json npm
  • @commitlint/cli ^17.1.2 development
  • @commitlint/config-conventional ^17.1.0 development
  • husky ^8.0.1 development
.github/workflows/deploy.yml actions
.github/workflows/quality-check.yml actions
  • actions/checkout v4 composite
  • actions/setup-node v4.4.0 composite
.github/workflows/release-please.yml actions
  • googleapis/release-please-action v4 composite
npm-shrinkwrap.json npm
  • 192 dependencies