🙌 .github Repository

Community Guidelines, Templates & Configuration for dynamicdev-official

Contents • Setup • Contributing • Support

---

📖 What's This?

This is the .github repository for the dynamicdev-official organization.

It contains:

• 🎨 Organization profile README
• 📋 Contributing guidelines
• 🤝 Code of conduct
• 🔒 Security policy
• 📝 Issue & PR templates
• 🔄 GitHub Actions workflows

These files provide a foundation for maintaining code quality and community standards across all organization repositories.

---

📁 Contents

Organization Profile

profile/
├── README.md                    # Organization homepage
└── images/
    ├── logo.png
    └── banner.png

Location: https://github.com/dynamicdev-official

Community Guidelines

├── CONTRIBUTING.md              # How to contribute
├── CODE_OF_CONDUCT.md           # Community standards
├── SECURITY.md                  # Security policy & reporting
└── README.md                    # This file

Issue Templates

ISSUE_TEMPLATE/
├── bug_report.md                # 🐛 Bug report template
├── feature_request.md           # ✨ Feature request template
└── documentation.md             # 📚 Documentation issue template

Pull Request Template

├── pull_request_template.md     # PR submission guidelines

Workflows (CI/CD)

workflows/
├── lint.yml                     # Code quality checks
├── tests.yml                    # Automated testing
└── release.yml                  # Release automation

---

🎯 Quick Links

For Repository Contributors

• CONTRIBUTING.md - Contribution guidelines

  • Development setup
  • Commit message format
  • PR process
  • Code standards

• CODE_OF_CONDUCT.md - Community standards

  • Expected behavior
  • Unacceptable behavior
  • Reporting violations

• SECURITY.md - Security policy

  • Vulnerability reporting
  • Security best practices
  • Supported versions

For Repository Maintainers

• profile/README.md - Organization homepage
• Issue templates - Template customization
• PR template - PR guidelines
• Workflows - CI/CD automation

---

📝 Issue Template Guide

When to Use Each Template

🐛 Bug Report

Use when reporting a bug or defect:

• Something is broken
• Unexpected behavior
• Error messages
• Performance issues

✨ Feature Request

Use when suggesting new functionality:

• New features
• Feature enhancements
• Improvement ideas
• Use case requests

📚 Documentation

Use when reporting documentation issues:

• Missing documentation
• Unclear explanations
• Outdated information
• Incorrect examples

---

🔄 Workflow Automation

Available Workflows

Workflow	Trigger	Purpose
lint.yml	push, pull_request	Code quality checks (flake8, pylint, black)
tests.yml	push, pull_request	Run test suite with coverage
release.yml	release	Build and publish releases

Enabling in Your Repository

Each repository can enable workflows independently:

# Workflows are inherited from .github/workflows/
# but each repo controls what runs via:
# 1. Settings > Actions > Workflow permissions
# 2. .github/workflows/ in the repo (overrides org workflows)

---

🚀 Setup for New Repositories

Step 1: Create Repository

# Create new repo on GitHub
# Settings > Add repository

Step 2: Add Organization Files

# These are inherited automatically:
# ✅ CONTRIBUTING.md
# ✅ CODE_OF_CONDUCT.md
# ✅ SECURITY.md
# ✅ Issue templates
# ✅ PR templates
# ✅ Workflows

# Plus add repository-specific:
# - README.md (in repo root)
# - LICENSE.md (in repo root)

Step 3: Enable Branch Protection

# Settings > Branches > Add rule
# Branch name pattern: main or master

# Require:
# ✅ Pull request reviews before merging
# ✅ Status checks to pass before merging
# ✅ Require branches to be up to date

---

📋 File Descriptions

CONTRIBUTING.md

Advanced contribution guidelines including:

• Code of Conduct
• Getting started
• Development environment setup
• Making changes & git workflow
• Commit message format (Conventional Commits)
• Pull request process
• Coding standards (PEP 8+)
• Testing requirements
• Documentation standards
• Release process

👉 Use for: All repositories needing contributor guidelines

CODE_OF_CONDUCT.md

Community standards establishing:

• Commitment to inclusivity
• Expected behavior
• Unacceptable behavior
• Scope of application
• Enforcement procedures
• Support resources

👉 Use for: Creating welcoming community

SECURITY.md

Security policy covering:

• Vulnerability reporting process
• Responsible disclosure timeline
• Supported versions
• Security best practices
• Built-in protections
• Security scanning tools
• Incident response
• Compliance standards

👉 Use for: Security-conscious projects

Issue Templates

Structured templates for:

• Bug reports (reproduction steps, environment)
• Feature requests (use cases, alternatives)
• Documentation issues (location, current vs. expected)

👉 Use for: Better issue quality

Pull Request Template

Comprehensive PR checklist:

• Description & type
• Related issues
• Testing details
• Code quality checks
• Security review
• Breaking changes
• Documentation updates
• Pre-submission checklist

👉 Use for: Thorough PR reviews

---

🔗 How GitHub Recognizes These Files

GitHub automatically uses these files when present in .github/:

✅ CONTRIBUTING.md        → Shown when creating PR
✅ CODE_OF_CONDUCT.md     → Listed on org page
✅ SECURITY.md            → Security policy tab
✅ LICENSE.md             → License information
✅ FUNDING.yml            → Sponsorship info
✅ ISSUE_TEMPLATE/        → Issue creation forms
✅ pull_request_template.md → PR form
✅ workflows/             → GitHub Actions

---

🔧 Customization

Per-Repository Customization

Some files can be overridden in individual repositories:

repo-name/
├── CONTRIBUTING.md              # Overrides org CONTRIBUTING.md
├── .github/
│   ├── workflows/
│   │   └── custom.yml           # Custom workflows
│   └── ISSUE_TEMPLATE/
│       └── custom.md            # Custom issue template

Workflow Override Example

# Organization workflow
.github/workflows/lint.yml

# Repository-specific override
my-repo/.github/workflows/lint.yml
# ← Uses repo version if present

---

📖 Documentation Structure

Recommended Repo Layout

repository/
├── README.md                    # Project overview
├── LICENSE.md                   # License file
├── CONTRIBUTING.md              # From .github (if not overridden)
├── CODE_OF_CONDUCT.md           # From .github (if not overridden)
├── SECURITY.md                  # From .github (if not overridden)
│
├── docs/
│   ├── INSTALL.md               # Installation guide
│   ├── SETUP.md                 # Setup instructions
│   ├── USAGE.md                 # How to use
│   ├── API.md                   # API documentation
│   └── ARCHITECTURE.md          # Technical architecture
│
├── src/
│   └── (source code)
│
├── tests/
│   └── (test files)
│
├── .github/
│   └── workflows/
│       └── (repo-specific workflows)
│
└── docker-compose.yml           # If using containers

---

🎯 Best Practices

For Organization Maintainers

1. Keep org-level files generic

   • Apply to all repositories
   • Don't mention specific projects

2. Update templates regularly

   • Review annually
   • Incorporate community feedback
   • Follow GitHub best practices

3. Test workflows before deploying

   • Test in a dev branch first
   • Verify with sample repositories

For Repository Contributors

1. Follow organization guidelines

   • Use provided templates
   • Follow commit conventions
   • Respect code of conduct

2. Keep repos consistent

   • Use same structure
   • Follow same standards
   • Maintain compatibility

---

🚀 Getting Started

As a Contributor

1. Read CONTRIBUTING.md

   • Understand process
   • Set up development environment
   • Learn coding standards

2. Review CODE_OF_CONDUCT.md

   • Understand community values
   • Respect all community members

3. Check SECURITY.md

   • Learn security best practices
   • Know how to report issues

As a Maintainer

1. Customize templates (if needed)

   • Override in repository
   • Add project-specific sections

2. Enable workflows

   • Check Actions settings
   • Verify branch protection rules

3. Keep updated

   • Review regularly
   • Incorporate feedback

---

📞 Support

Questions?

• 📧 Email: support@dynamicdev.asia
• 🐛 Issues: GitHub Issues
• 💬 Discussions: GitHub Discussions

Contributing to .github

To improve these templates:

1. Open an issue describing your suggestion
2. Or create a PR with improvements
3. Discuss with maintainers

---

📄 License

All files in this repository are licensed under the MIT License.

---

🙏 Credits

These guidelines are inspired by:

• Contributor Covenant
• GitHub Community
• Open Source Best Practices

---

📢 About dynamicdev-official

dynamicdev-official is a technology organization focused on:

• Infrastructure automation
• System engineering
• Network deployment
• Open-source tools

Explore our projects:

• 🚀 UI-Mid-Controller
• 🤖 syscare-dynamicdev
• 🔧 dynamicdev_agent

Learn more: dynamicdev.asia

Connect: @dynamicdev-official

Copyright © 2026 dynamicdev_ official — All Rights Reserved

Made with ❤️ by the dynamicdev-official community

⬆ Back to top