Skip to content

feat: Add AGENTS.md repository guidelines document#3

Merged
hemonserrat merged 2 commits into
masterfrom
open-swe/9aba6399-8c7a-41c1-8d5c-cbb8eca7bb7c
Aug 27, 2025
Merged

feat: Add AGENTS.md repository guidelines document#3
hemonserrat merged 2 commits into
masterfrom
open-swe/9aba6399-8c7a-41c1-8d5c-cbb8eca7bb7c

Conversation

@open-swe
Copy link
Copy Markdown

@open-swe open-swe Bot commented Aug 27, 2025

Fixes #2

Owner: @hemonserrat

Description

This pull request adds a comprehensive AGENTS.md file to the repository, providing clear guidelines and context for developers and agents working with the IoT micro Finite State Machine (uFSM) library.

The AGENTS.md document includes five key sections:

  1. General Rules: Provides C++ development guidelines specific to the IoT FSM library, including:

    • Directory structure conventions
    • Naming conventions
    • C++11 standard compliance
    • Doxygen documentation requirements
  2. Repository Structure: Offers a high-level technical overview of the library's organization, highlighting key directories and files.

  3. Dependencies and Installation: Explains the CMake-based dependency management and build process.

  4. Testing Instructions: Describes the Catch2 testing framework, test file locations, and testing best practices.

  5. Pull Request Formatting: Left empty as no specific repository-level guidelines were found.

This document will help new contributors quickly understand the project's structure, development practices, and contribution guidelines.

Changes

  • Created AGENTS.md in the repository root
  • Documented comprehensive guidelines for the IoT-uFSM C++ library
  • Provided context for repository structure, dependencies, and testing

Checklist

  • Created AGENTS.md with all required sections
  • Wrapped sections in appropriate XML tags
  • Ensured content is concise and informative

@open-swe open-swe Bot added the open-swe label Aug 27, 2025
@open-swe open-swe Bot changed the title [WIP]: Create AGENTS.md repository guidelines document for IoT-uFSM C++ library feat: Add AGENTS.md repository guidelines document Aug 27, 2025
@sonarqubecloud
Copy link
Copy Markdown

@hemonserrat hemonserrat marked this pull request as ready for review August 27, 2025 23:19
@hemonserrat hemonserrat merged commit 8cd5f68 into master Aug 27, 2025
3 checks passed
@hemonserrat
Copy link
Copy Markdown
Owner

@CodiumAI-Agent /review

@hemonserrat hemonserrat deleted the open-swe/9aba6399-8c7a-41c1-8d5c-cbb8eca7bb7c branch September 11, 2025 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create AGENTS.md Repository Guidelines Document

2 participants