This repository contains organization-wide default files, templates, workflows, and governance documentation for the Coffee Code Philly Accelerator GitHub organization.
This repository serves as the central configuration and documentation hub for all Coffee Code Philly projects.
Located in .github/, these files provide defaults for all repositories in the organization:
- CODE_OF_CONDUCT.md - Our community standards and enforcement
- CONTRIBUTING.md - How to contribute to our projects
- SECURITY.md - Security policy and vulnerability reporting
- SUPPORT.md - Where to get help and support
- GOVERNANCE.md - Organization structure and decision-making
- CODEOWNERS - Code ownership and review assignments
Issue Templates (.github/ISSUE_TEMPLATE/):
- Bug Report - Report bugs
- Feature Request - Suggest features
- Documentation - Improve docs
- Config - Template chooser configuration
Pull Request Template:
- Pull Request Template - Standard PR format
Located in .github/workflows/, these provide reusable CI/CD pipelines:
- ci-python.yml - Python testing and linting
- ci-node.yml - Node.js testing and linting
- security-scan.yml - Security scanning and analysis
- label-sync.yml - Synchronize issue labels
- welcome.yml - Welcome first-time contributors
Comprehensive guides for contributors and maintainers:
For Contributors:
- Getting Started - Your first contribution
- Development Setup - Setting up your environment
- Code Review Process - How code review works
- FAQ - Frequently asked questions
For Maintainers:
- Maintainer Onboarding - New maintainer guide
- Release Process - How to release
- Security Response - Handling security issues
Technical:
- Architecture Overview - System architecture and tech stack
Located in profile/:
- README.md - Public organization profile page
- Read the Code of Conduct
- Review the Contributing Guidelines
- Follow the Getting Started Guide
- Find an issue labeled
good-first-issue - Join our community at phillycodes.rsvp
- Read the Governance Document
- Review the Maintainer Onboarding
- Understand the Release Process
- Know the Security Response procedures
.github/
├── .github/ # Community health files
│ ├── CODE_OF_CONDUCT.md
│ ├── CONTRIBUTING.md
│ ├── GOVERNANCE.md
│ ├── SECURITY.md
│ ├── SUPPORT.md
│ ├── CODEOWNERS
│ ├── labels.yml
│ ├── ISSUE_TEMPLATE/
│ │ ├── bug_report.md
│ │ ├── feature_request.md
│ │ ├── documentation.md
│ │ └── config.yml
│ ├── pull_request_template.md
│ └── workflows/
│ ├── ci-python.yml
│ ├── ci-node.yml
│ ├── security-scan.yml
│ ├── label-sync.yml
│ └── welcome.yml
├── docs/ # Documentation
│ ├── getting-started.md
│ ├── development-setup.md
│ ├── review-process.md
│ ├── architecture.md
│ ├── faq.md
│ └── maintainers/
│ ├── onboarding.md
│ ├── release-process.md
│ └── security-response.md
├── profile/ # Organization profile
│ └── README.md
└── README.md # This file
Files in the .github/.github/ directory serve as organization-wide defaults:
- If a repository doesn't have its own
CONTRIBUTING.md, the one from this repo is used - Same applies for all community health files
- Issue and PR templates are inherited by all repos
- Workflows can be referenced from other repositories
Individual repositories can override these defaults by:
- Creating their own versions of these files
- Customizing templates for specific needs
- Adding repository-specific documentation
When updating community health files:
- Open a PR with proposed changes
- Discuss with maintainers and community
- Get approval from organization owners
- Merge and changes take effect organization-wide
To add a new issue or PR template:
- Create the template file in the appropriate directory
- Update this README
- Test with a sample issue/PR
- Announce to maintainers
When modifying GitHub Actions workflows:
- Test in a feature branch first
- Verify it works with actual repositories
- Review for security implications
- Document any changes in commit message
Keep documentation current:
- Review quarterly for accuracy
- Update based on community feedback
- Add examples and clarifications as needed
- Ensure consistency across all docs
- Everyone can suggest improvements via issues
- Maintainers can submit PRs
- Organization Owners approve governance changes
Encouraged:
- Improving clarity of documentation
- Fixing typos and broken links
- Adding helpful examples
- Updating outdated information
- Suggesting new templates or workflows
Requires Discussion:
- Changing governance structure
- Modifying Code of Conduct
- Changing security policies
- Adding required workflows
- Open an issue to discuss larger changes
- Fork this repository
- Create a branch:
git checkout -b improve-docs - Make your changes
- Submit a PR following the template
- Tag relevant maintainers for review
These defaults affect all repositories in the Coffee Code Philly Accelerator organization:
Every repository benefits from these defaults unless they provide their own overrides.
This repository contains organization governance and configuration:
- No secrets or credentials are stored here
- All content is public
- Security policies are documented in SECURITY.md
- Report security concerns to [email protected]
- General Questions: Open an issue or discussion
- Governance: Email [email protected]
- Security: Follow Security Policy
- Community: Join us on phillycodes.rsvp
Documentation and configuration files in this repository are available under the MIT License.
Individual project repositories may use different licenses - check each repository's LICENSE file.
This repository structure and documentation is inspired by best practices from:
- GitHub's own .github repositories
- Large open source organizations
- Community feedback and contributions
Thank you to all contributors who help maintain and improve our community standards! ☕️