diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml new file mode 100644 index 0000000..4a6b9a5 --- /dev/null +++ b/.github/workflows/codeql.yml @@ -0,0 +1,98 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL Advanced" + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + schedule: + - cron: '28 2 * * 0' + +jobs: + analyze: + name: Analyze (${{ matrix.language }}) + # Runner size impacts CodeQL analysis time. To learn more, please see: + # - https://gh.io/recommended-hardware-resources-for-running-codeql + # - https://gh.io/supported-runners-and-hardware-resources + # - https://gh.io/using-larger-runners (GitHub.com only) + # Consider using larger runners or machines with greater resources for possible analysis time improvements. + runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }} + permissions: + # required for all workflows + security-events: write + + # required to fetch internal or private CodeQL packs + packages: read + + # only required for workflows in private repositories + actions: read + contents: read + + strategy: + fail-fast: false + matrix: + include: + - language: c-cpp + build-mode: auto + # CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'rust', 'swift' + # Use `c-cpp` to analyze code written in C, C++ or both + # Use 'java-kotlin' to analyze code written in Java, Kotlin or both + # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both + # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis, + # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning. + # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how + # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + # Add any setup steps before running the `github/codeql-action/init` action. + # This includes steps like installing compilers or runtimes (`actions/setup-node` + # or others). This is typically only required for manual builds. + # - name: Setup runtime (example) + # uses: actions/setup-example@v1 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v3 + with: + languages: ${{ matrix.language }} + build-mode: ${{ matrix.build-mode }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + + # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs + # queries: security-extended,security-and-quality + + # If the analyze step fails for one of the languages you are analyzing with + # "We were unable to automatically build your code", modify the matrix above + # to set the build mode to "manual" for that language. Then modify this step + # to build your code. + # ℹī¸ Command-line programs to run using the OS shell. + # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun + - if: matrix.build-mode == 'manual' + shell: bash + run: | + echo 'If you are using a "manual" build mode for one or more of the' \ + 'languages you are analyzing, replace this with the commands to build' \ + 'your code, for example:' + echo ' make bootstrap' + echo ' make release' + exit 1 + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v3 + with: + category: "/language:${{matrix.language}}" diff --git a/README.md b/README.md index 10b6d04..2c5955c 100644 --- a/README.md +++ b/README.md @@ -1,90 +1,4 @@ -Formatting.**# Project Title +# onchaintestkit -## Quickstart - -Instructions on how to quickly get started with this project. - -## Why use - -Reasons to use this project. - -## Getting Commercial Support - -Information on how to get commercial support for this project. - -## Contribute - -Guidelines on how to contribute to this project. - -- **Write and maintain documentation (`README.md`, `CONTRIBUTING.md # Enterprise-Ready Software Engineering Project - -Welcome to the **Enterprise-Ready Software Engineering Project**. This repository is designed for professional development in Python, Java, and C++ with a focus on enterprise-grade solutions, scalability, and maintainability. - ---- - -## 🚀 Business Focus - -This project is tailored for **business enterprise-ready** solutions, ensuring professional-grade software engineering practices. It emphasizes: - -- **Scalability**: Designed to handle enterprise-level workloads. -- **Maintainability**: Code structured for long-term use and collaboration. -- **Integration**: Seamless integration with existing enterprise systems. - ---- - -## 🧑‍đŸ’ģ Your Role - -- **Role Type**: `{role_type}` expert in `{domain}` -- **Focus Area**: `{key_skill_area}` - -As a contributor, your expertise in `{domain}` will help shape the success of this project. Focus on `{key_skill_area}` to ensure high-quality contributions. - ---- - -## 📜 Code Guidelines - -### General Guidelines - -- Use **language-specific conventions** for Python, Java, and C++. -- Follow **design patterns** and **best practices** for enterprise software. -- Optimize for **performance**, **readability**, and **scalability**. - -### Python - -- Follow [PEP 8](https://peps.python.org/pep-0008/) for coding standards. -- Use type hints and docstrings for better readability. -- Write unit tests using `unittest` or `pytest`. - -### Java - -- Adhere to [Oracle's Java Code Conventions](https://www.oracle.com/java/technologies/javase/codeconventions-introduction.html). -- Use Maven or Gradle for dependency management. -- Write JUnit tests for all major components. - -### C++ - -- Follow [Google's C++ Style Guide](https://google.github.io/styleguide/cppguide.html). -- Use `CMake` for build configuration. -- Ensure memory safety and avoid undefined behavior. - ---- - -## 🔧 Integration - -This project is designed to integrate seamlessly with enterprise systems. Key integration points include: - -- **APIs**: RESTful APIs for communication between services. -- **Databases**: Support for relational and NoSQL databases. -- **CI/CD Pipelines**: Automated testing and deployment workflows. - ---- - -## 📚 Further Reading - -- [Python Best Practices](https://realpython.com/) -- [Java Design Patterns](https://java-design-patterns.com/) -- [C++ Modern Practices](https://isocpp.org/) - ---- - -For questions or support, please open an issue or contact the project maintainer. \ No newline at end of file +[https://github.com/joe10832/onchaintestkit](https://github.com/joe10832/onchaintestkit) +A simple CLI Linux/Unix utility, written in C++.