Core_Source_Revision_Controlled_Git
Core Source Revision-Controlled Git Repository
This repository is intended for the management and maintenance of Open Core or Intellectual Property (IP) Core source code. It provides a structured environment for development, review, and versioning of Core files, using Git as the revision control system.
- To store and organise Core source code in a structured repository.
- To use revision control for tracking changes, maintaining history, and supporting collaborative development.
- To provide transparency in development and enable reliable rollback to stable versions.
- To facilitate code review and comparison of revisions.
- Digital design projects, including FPGA and ASIC development.
- Engineering teams requiring collaborative version control.
- Educational environments where Core development is combined with version control practices.
- Git as the primary revision control system.
- Simulation and synthesis tools commonly used in hardware design.
- CI/CD tools may be integrated for automated testing and verification.
A consistent naming convention shall be used for all project-defined names throughout the repository.
- Use lowercase letters only.
- Use underscores to separate words.
- Numbers are allowed.
- Do not start or end a name with an underscore.
- Do not use consecutive underscores (
__).
This convention applies to source files, directories, HDL objects, scripts, constraints, and other project-defined names across the repository.
Vendor-defined names, language keywords, tool commands, tool properties, and standard interface names are excluded from this convention.
To keep the repository portable across Linux, Windows and macOS, avoid special characters in its filesystem path.
Use only letters, numbers and underscores (_) in directory names.
Do not use spaces, punctuation or characters such as:
. - + ! @ # $ % ^ & * ( ) [ ] { } ' " \ / :
This rule applies to the repository directory and its parent directories.