project-bootstrap

Just a common starting point for me whenever I want a new repo.

https://github.com/npazzaglia/project-bootstrap

Science Score: 44.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
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.3%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Just a common starting point for me whenever I want a new repo.

Basic Info
  • Host: GitHub
  • Owner: npazzaglia
  • License: mit
  • Language: Shell
  • Default Branch: main
  • Size: 37.1 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created about 1 year ago · Last pushed 7 months ago
Metadata Files
Readme Changelog Contributing Funding License Code of conduct Citation Codeowners Security Support

README.md

project-bootstrap

🛠️ A modern, opinionated GitHub template for scaffolding clean, documented, and CI-ready software projects.

License: MIT CI CodeQL GitHub Template

An organizational template for clean, secure, and automation-ready projects.

Overview

This repository serves as a template for creating robust and scalable software projects. It includes the following components: - Source Code: Located in the src/ directory. - Tests: Located in the tests/ directory. - Documentation: Located in the docs/ directory. - Configuration Files: Located in the config/ directory. - Scripts: Utility scripts in the scripts/ directory.

Getting Started

Prerequisites

Installation

Clone the repository: bash git clone https://github.com/npazzaglia/project-bootstrap.git cd project-bootstrap make install

Post-Fork Setup

After cloning or forking this template, run the following bootstrap to initialize your local environment:

bash make bootstrap

This will: - Validate GitHub CLI auth - Set up repo metadata - Run project-specific initialization

Running the Project

```bash make run

or, if defined, run your app manually:

python src/main.py

```

Running Tests

bash make test


📚 Documentation


🤝 Contributing

Pull requests are welcome! For major changes, open an issue first to propose your idea.

Please review CONTRIBUTING.md and CODE_OF_CONDUCT.md before contributing.


📄 License

MIT License. See LICENSE for full details.

Owner

  • Name: Nick Pazzaglia
  • Login: npazzaglia
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this project, please cite it as below."
authors:
  - family-names: Pazzaglia
    given-names: Nick
title: "project-bootstrap"
version: "0.1.0-alpha"
date-released: 2025-06-19
type: software
repository-code: "https://github.com/npazzaglia/project-bootstrap"

GitHub Events

Total
  • Delete event: 8
  • Issue comment event: 1
  • Public event: 1
  • Push event: 20
  • Pull request event: 27
  • Fork event: 1
  • Create event: 13
Last Year
  • Delete event: 8
  • Issue comment event: 1
  • Public event: 1
  • Push event: 20
  • Pull request event: 27
  • Fork event: 1
  • Create event: 13

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
.github/workflows/codeql.yml actions
  • actions/checkout v4 composite
  • github/codeql-action/analyze v3 composite
  • github/codeql-action/autobuild v3 composite
  • github/codeql-action/init v3 composite