Skip to content

Conversation

@bialger
Copy link
Contributor

@bialger bialger commented Sep 7, 2025

Initiated the repository:

  • Wrote the build instructions, described the code style, contribution rules, etc.
  • Compiled a draft version of the Ovum language standard with structured language reference
  • Updated the names of CMake and CI/CD targets
  • Improved the repository structure

…ypes

Add matches for build artifacts, IDE configurations, temporary files, and cache directories.
Refactor the CI configuration to replace 'cpp_tests' with 'ovum' for building and running the main application and tests. This includes updates to the build commands and executable names in both release and debug configurations.
Introduce comprehensive documentation for the Ovum programming language, including build instructions in BUILD.md, a Code of Conduct in CODE_OF_CONDUCT.md, and coding guidelines in CODING_GUIDELINES.md. Update README.md to reflect the new structure and provide an overview of the language's features and syntax.
Introduce .clang-format for consistent C++ code styling based on Google style guidelines, and .clang-tidy for static analysis checks focusing on modern C++ practices, performance, and core guidelines.
Change project name from 'cpp_tests' to 'ovum' across CMakeLists.txt, install script, and related build configurations. Adjust output directories and build types for better organization and clarity. Clean up unnecessary conditions and improve script handling for configuration directories.
…ty support

Update the README to provide a comprehensive overview of the Ovum programming language, including new sections on nullable types, functional objects, and detailed syntax rules. Clarify naming conventions and access modifiers, and improve examples to illustrate language capabilities. Adjust structure for better readability and understanding of key concepts.
…lines

Introduce CODEBASE_STRUCTURE.md to outline the repository's structure and directory purposes. Add CONTRIBUTING.md to provide clear instructions for contributing to the project, including forking, branching, and commit message guidelines. Update README.md to reference these new documents for better onboarding and contribution clarity.
…ns and external libraries

Extract compiler options and external library configurations into separate CMake files for improved organization and maintainability. Update main CMakeLists.txt to include these new files and remove redundant code from the tests directory related to GoogleTest integration.
…organization

Revise CODEBASE_STRUCTURE.md to enhance clarity on the repository's directory structure. Introduce detailed sections for the root directory, bin, lib, tests, and CI/CD configurations, providing clear descriptions of each component's purpose and organization for improved onboarding and understanding.
…estSuite

Move test files into a dedicated directory for better organization. Introduce ProjectIntegrationTestSuite with setup and teardown methods for managing temporary directories during tests. Update includes in main_test.cpp to reflect the new structure and remove unnecessary includes from test_functions.hpp.
@bialger bialger requested a review from biqiboqi September 7, 2025 20:23
@bialger bialger self-assigned this Sep 7, 2025
…rol flow details

Revise the README.md to include a detailed design philosophy section outlining Ovum's core principles such as memory safety, immutability, and pure functions. Expand the control flow section to cover conditional execution and loop constructs, providing clear examples for better understanding. Update type system characteristics and memory management sections for clarity and completeness.
…words

Revise the README.md to replace instances of `mut` with `var` for mutable variables and `let` with `val` for immutable variables, aligning with the updated language syntax. Adjust naming conventions and examples throughout the document to ensure consistency and clarity in the description of Ovum's design principles and features.
…nce materials

Add a new BUILD.md file detailing the build process for the Ovum toolset. Update README.md to direct users to the new project documentation index and language reference. Introduce multiple reference documents covering various aspects of the Ovum language, enhancing the overall documentation structure for better accessibility and clarity.
…g and new content

Revise the README.md to reflect updated section numbers for Formal Grammar, Expressions and Operators, Lexer & Parser Rules, and Memory Management. Introduce new documentation files covering built-in reference types, control flow constructs, and the overall design philosophy of the Ovum language. Enhance clarity and organization of the documentation to improve user understanding and accessibility.
Update README.md to enhance the overview of the Ovum programming language, emphasizing its design principles and key features. Revise code examples for better clarity, including adjustments to nullable type handling and function definitions. Ensure consistency in naming conventions and improve the overall structure for better user comprehension.
… String, Nullable, and System Library

Enhance the documentation for built-in types in Ovum by providing comprehensive details on the String type, including its methods and usage examples. Expand the Nullable types section to clarify their creation, method call restrictions, and null handling operators. Additionally, significantly enrich the System Library documentation with extensive information on I/O operations, time functions, file handling, process control, and system information, ensuring clarity and usability for developers.
Remove unnecessary newline at the end of the primitive types documentation. Add a note in the syntax documentation clarifying the purpose of the `#define` preprocessor directive, enhancing the overall clarity and usability of the documentation.
@bialger bialger added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 9, 2025
…INES.md, CONTRIBUTING.md, and README.md for clarity and consistency

Revise the CODE_OF_CONDUCT.md to reflect the Contributor Covenant format, enhancing inclusivity and clarity. Update CODEBASE_STRUCTURE.md to provide clear descriptions of directory purposes in English. Revise CODING_GUIDELINES.md for improved readability and consistency in coding practices. Update CONTRIBUTING.md to streamline the contribution process and ensure clarity in instructions. Enhance README.md by adding details on polymorphism and clarifying language features, improving overall documentation quality.
…d new features

Revise the code examples section to reflect changes in memory management and unsafe operations, including new examples for type aliases and destructors. Update the reference documentation to include type aliases in the design principles and lexical structure sections, enhancing clarity and usability. Remove the obsolete primitive types documentation and adjust related references accordingly.
@bialger bialger requested a review from biqiboqi September 9, 2025 07:23
Copy link

@biqiboqi biqiboqi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sgtm :)

Change the contact email for reporting abusive or unacceptable behavior to ensure proper communication with the project team.
Copy link

@biqiboqi biqiboqi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sgtm and lgtm...

@bialger bialger merged commit 5af820d into master Sep 9, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants