base
PhilosophyWelcome to base
.
This repository is designed to be a robust, professional, and
well-documented starting point for new software and publishing
projects.
The development of this template is guided by a few core principles:
Code-Independent: The template should not be tied to a specific programming language. The goal is to provide a solid foundation of repository structure, CI/CD, and best practices that can be adapted to any language or framework.
Well-Documented: Every component, workflow, and configuration file is
documented in the docs
directory.
The goal is to make the repository easy to understand and modify.
See the documentation index for a complete list of
documents.
Guidance Over Prescription: The template provides sensible defaults and placeholder files that guide the user on how to create their own project-specific content, such as contributing guidelines or a license.
Automation: The template includes automated workflows for common tasks like linting, testing, and creating releases, helping to ensure code quality and streamline the development process.
This repository is intended to be used as a GitHub Template. Click the “Use this template” button at the top of the repository page to create your own new repository with the same structure and files.