Skip to content

Add community files and documentation#5

Merged
bburda merged 1 commit intomainfrom
add_basic_community_docs
Nov 17, 2025
Merged

Add community files and documentation#5
bburda merged 1 commit intomainfrom
add_basic_community_docs

Conversation

@bburda
Copy link
Collaborator

@bburda bburda commented Nov 17, 2025

Add CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md, and GitHub issue/PR templates to establish contribution guidelines and community standards for the project.

Add CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md, and GitHub
issue/PR templates to establish contribution guidelines and community
standards for the project.
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR establishes comprehensive community standards and contribution guidelines for the DiagTree project by adding essential documentation files and GitHub templates.

  • Adds security policy with clear vulnerability reporting procedures
  • Introduces contribution guidelines with development workflow and coding standards
  • Establishes code of conduct based on industry-standard templates
  • Updates README with project overview and structure explanation
  • Enhances .gitignore with comprehensive patterns for ROS2, C++, and Python

Reviewed Changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated no comments.

Show a summary per file
File Description
SECURITY.md Defines security vulnerability reporting process, supported versions, and best practices
README.md Expands project description with entity tree model explanation and links to community files
CONTRIBUTING.md Provides detailed contribution workflow, build/test requirements, and PR checklist
CODE_OF_CONDUCT.md Establishes community standards based on GitHub and Contributor Covenant templates
.gitignore Adds comprehensive ignore patterns for ROS2, C++, and Python development
.github/PULL_REQUEST_TEMPLATE.md Creates structured PR template with type classification and checklist
.github/ISSUE_TEMPLATE/issue.md Adds feature request/general issue template with structured sections
.github/ISSUE_TEMPLATE/bug.md Adds bug report template with reproduction steps and environment info

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@bburda bburda self-assigned this Nov 17, 2025
@bburda bburda merged commit 076e65c into main Nov 17, 2025
6 checks passed
@bburda bburda deleted the add_basic_community_docs branch November 17, 2025 21:40
bburda added a commit that referenced this pull request Mar 6, 2026
- Guard substr(0,2) against empty collection strings (Copilot #1)
- Use segment-based path traversal check instead of substring matching,
  allowing benign paths like '/..foo' while still rejecting '/..' segments (Copilot #2,#7)
- Add thread-safety to TransportRegistry via shared_mutex (Copilot #10)
- Reject duplicate transport protocol registration (Copilot #6)
- Validate data collection requires resource_path (topic name) (Copilot #8)
- Document set_on_removed() init-only constraint for thread safety (Copilot #3,#4)
- Explain SSE stop() behavior in comments (Copilot #5)
- Remove redundant subscription_mgr_->shutdown() call in destructor (Copilot #11)
- Fix shutdown_all() docstring to match delegation pattern (Copilot #9)
- Fix clang-tidy: use const ref for captured_sub_id (CI failure)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add basic community docs (CODE_OF_CONDUCT, CONTRIBUTING, etc.)

2 participants