Skip to content
cometbid-sfiPublic

Latest commit

Β 

History

53 Commits

Folders and files

Repository files navigation

πŸ‡³πŸ‡¬ πŸ‡¨πŸ‡¦ πŸ‡ΊπŸ‡Έ πŸ‡¬πŸ‡­ πŸ‡ΏπŸ‡¦ πŸ‡°πŸ‡ͺ πŸ‡¬πŸ‡§

The Cometbid Technology Foundation

An Open Source Platform for Innovation and Collaboration

License Contributor Covenant PRs Welcome

About This Repository

This repository contains the default community health files for The Cometbid Technology Foundation. These files will be used for any public repository in the organization that does not contain its own file of that type.

Repository Structure

.github/
β”œβ”€β”€ ISSUE_TEMPLATE/
β”‚ β”œβ”€β”€ bug_report.md
β”‚ β”œβ”€β”€ feature_request.md
β”‚ β”œβ”€β”€ documentation.md
β”‚ β”œβ”€β”€ security.md
β”‚ └── config.yml
β”œβ”€β”€ PULL_REQUEST_TEMPLATE/
β”‚ β”œβ”€β”€ bug_fix.md
β”‚ β”œβ”€β”€ feature.md
β”‚ β”œβ”€β”€ documentation.md
β”‚ β”œβ”€β”€ breaking_change.md
β”‚ └── config.yml
β”œβ”€β”€ workflows/
β”‚ β”œβ”€β”€ ci.yml
β”‚ β”œβ”€β”€ dependency-review.yml
β”‚ └── security.yml
β”œβ”€β”€ CODE_OF_CONDUCT.md
β”œβ”€β”€ CONTRIBUTING.md
β”œβ”€β”€ FUNDING.yml
β”œβ”€β”€ SECURITY.md
└── SUPPORT.md

Default Community Health Files

File Purpose
CODE_OF_CONDUCT.md Guidelines for community behavior
CONTRIBUTING.md How to contribute to our projects
FUNDING.yml Sponsorship information
SECURITY.md Security policy and reporting vulnerabilities
SUPPORT.md How to get help with our projects

Issue Templates

We provide several issue templates to help contributors create meaningful issues:

  • Bug Report: For reporting bugs and unexpected behavior
  • Feature Request: For suggesting new features or improvements
  • Documentation: For documentation-related issues
  • Security: For reporting security vulnerabilities

Pull Request Templates

Our pull request templates help maintain consistency in contributions:

  • Bug Fix: For fixes to existing functionality
  • Feature: For new feature implementations
  • Documentation: For documentation updates
  • Breaking Change: For changes that break backward compatibility

Workflows

Our GitHub Actions workflows automate various processes:

  • CI Pipeline: Automated testing and validation
  • Dependency Review: Security review of dependency changes
  • Security Checks: Automated security scanning

Getting Started

To use these templates in your repository:

  1. Create a new repository
  2. Copy the relevant templates to your repository's .github directory
  3. Customize the templates as needed
  4. Reference these files in your repository's documentation

Usage

Creating an Issue

  1. Go to the Issues tab
  2. Click "New Issue"
  3. Choose the appropriate template
  4. Fill in the required information

Creating a Pull Request

  1. Create your feature branch
  2. Make your changes
  3. Push to your branch
  4. Open a Pull Request
  5. Choose the appropriate template

Contributing

We welcome contributions from the community! Please read our Contributing Guidelines for details on how to submit pull requests, report issues, and contribute to our projects.

Code of Conduct

We are committed to fostering an inclusive and welcoming community. Please read our Code of Conduct for details on our expectations for participant behavior.

Security

For information about our security policies and how to report security vulnerabilities, please see our Security Policy.

Support

Need help? Check out our Support Guide for information on how to get assistance.

Sponsorship

If you find our projects valuable, please consider supporting us through one of our sponsorship options. See our Funding page for more information.

License

This repository is licensed under the Apache License 2.0 - see the LICENSE file for details.

Contact

Acknowledgments

Thank you to all our contributors and supporters who help make The Cometbid Technology Foundation possible!


Built with ❀️ by The Cometbid Technology Foundation Team