matlab-repo-init

Quickstart your public MATLAB repository

https://github.com/djmaxus/matlab-repo-init

Science Score: 59.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    2 of 5 committers (40.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.3%) to scientific vocabulary

Keywords

ci ci-cd github-action github-actions github-io-page license matlab matlab-toolbox release-automation repository semantic-versioning template

Keywords from Contributors

hack interpretability standardization meshing log-parser sequences projections optim parallel robust
Last synced: 6 months ago · JSON representation

Repository

Quickstart your public MATLAB repository

Basic Info
Statistics
  • Stars: 4
  • Watchers: 1
  • Forks: 3
  • Open Issues: 11
  • Releases: 36
Topics
ci ci-cd github-action github-actions github-io-page license matlab matlab-toolbox release-automation repository semantic-versioning template
Created over 1 year ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Citation Security

README.md

Template Repository for Open-Source MATLAB

CI View matlab-repo-init on File Exchange GitHub Tag GitHub Release Date License DOI

Quickstart your public MATLAB repository. Batteries included

logo <!-- markdownlint-enable MD033 -->

How to use

First, click Use this template to make your own repository from this template. Clone your new repository.

Then locally:

  1. Run init function for cleanup
  2. Upload your own MATLAB code
  3. Change anything else to your liking
  4. Commit changes appropriately along the way

Then, in Settings Actions General of your repository:

  1. [x] Allow all actions and reusable workflows
  2. [x] Allow GitHub Actions to create and approve pull requests

To enable repository webpage deployment:

  • [x] Settings Pages Build and deployment Source = GitHub Actions

You can also import a pre-built ruleset to protect main branch from accidental unwanted hard-to-recover changes.\ In Settings Rules Rulesets of your repository:

  1. Click New ruleset Import a ruleset
  2. Upload .github/rules/main.json
  3. Modify if needed and save

Then push the local changes and carry on with the development of your freshly established public MATLAB project!

Please go to repository's Wiki (when it's ready) for more detailed user manual.

Do not hesitate to ask me for assistance and technical support.\ And everyone is welcome to open issues to request a feature, enhance the documentation, or report a bug.

Known template users

|| |:-| |StrataTrapper| |par-waitbar|

Features

References

Owner

  • Name: Maksim Elizarev
  • Login: djmaxus
  • Kind: user

Reduced Order Modeling Researcher

GitHub Events

Total
  • Fork event: 2
  • Create event: 132
  • Release event: 29
  • Issues event: 106
  • Watch event: 3
  • Delete event: 105
  • Issue comment event: 71
  • Member event: 1
  • Push event: 284
  • Gollum event: 46
  • Pull request review comment event: 36
  • Pull request review event: 152
  • Pull request event: 225
Last Year
  • Fork event: 2
  • Create event: 132
  • Release event: 29
  • Issues event: 106
  • Watch event: 3
  • Delete event: 105
  • Issue comment event: 71
  • Member event: 1
  • Push event: 284
  • Gollum event: 46
  • Pull request review comment event: 36
  • Pull request review event: 152
  • Pull request event: 225

Committers

Last synced: 10 months ago

All Time
  • Total Commits: 143
  • Total Committers: 5
  • Avg Commits per committer: 28.6
  • Development Distribution Score (DDS): 0.329
Past Year
  • Commits: 143
  • Committers: 5
  • Avg Commits per committer: 28.6
  • Development Distribution Score (DDS): 0.329
Top Committers
Name Email Commits
Maksim Elizarev 4****s 96
github-actions[bot] 4****] 29
Alex Dewar a****r@i****k 11
dependabot[bot] 4****] 5
HarmonicReflux b****9@i****k 2
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 44
  • Total pull requests: 187
  • Average time to close issues: about 1 month
  • Average time to close pull requests: about 13 hours
  • Total issue authors: 4
  • Total pull request authors: 5
  • Average comments per issue: 0.66
  • Average comments per pull request: 0.25
  • Merged pull requests: 160
  • Bot issues: 1
  • Bot pull requests: 76
Past Year
  • Issues: 44
  • Pull requests: 185
  • Average time to close issues: about 1 month
  • Average time to close pull requests: about 13 hours
  • Issue authors: 4
  • Pull request authors: 5
  • Average comments per issue: 0.66
  • Average comments per pull request: 0.25
  • Merged pull requests: 158
  • Bot issues: 1
  • Bot pull requests: 75
Top Authors
Issue Authors
  • djmaxus (30)
  • alexdewar (14)
  • HarmonicReflux (1)
Pull Request Authors
  • djmaxus (113)
  • github-actions[bot] (64)
  • dependabot[bot] (15)
  • alexdewar (8)
  • HarmonicReflux (2)
Top Labels
Issue Labels
enhancement (6) osb (5) bug (4) umbrella (3) github_actions (3) good first issue (1) documentation (1)
Pull Request Labels
autorelease: pending (36) autorelease: tagged (28) dependencies (15) github_actions (14) enhancement (1)

Dependencies

.github/workflows/matlab-ci.yml actions
  • actions/checkout v4 composite
  • matlab-actions/run-build v2 composite
  • matlab-actions/setup-matlab v2 composite
.github/workflows/release-please.yml actions
  • googleapis/release-please-action v4 composite
.github/workflows/webpage.yml actions
  • actions/cache v4 composite
  • actions/checkout v4 composite
  • actions/configure-pages v5 composite
  • actions/deploy-pages v4 composite
  • actions/jekyll-build-pages v1 composite
  • actions/upload-pages-artifact v3 composite