{"id":30856914,"url":"https://github.com/swiftlang/repo-templates","last_synced_at":"2025-09-07T12:42:24.751Z","repository":{"id":309958207,"uuid":"845744880","full_name":"swiftlang/repo-templates","owner":"swiftlang","description":"Helpful file templates and guidance for repositories in github.com/swiftlang","archived":false,"fork":false,"pushed_at":"2025-08-26T20:17:50.000Z","size":58,"stargazers_count":3,"open_issues_count":3,"forks_count":1,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-08-31T18:03:02.076Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/swiftlang.png","metadata":{"files":{"readme":"README-template.md","changelog":null,"contributing":"CONTRIBUTING-custom.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-08-21T21:06:29.000Z","updated_at":"2025-08-26T23:15:13.000Z","dependencies_parsed_at":"2025-08-14T21:00:22.859Z","dependency_job_id":"e9edc296-6d3a-448d-9701-cad064940773","html_url":"https://github.com/swiftlang/repo-templates","commit_stats":null,"previous_names":["swiftlang/repo-templates"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/swiftlang/repo-templates","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swiftlang%2Frepo-templates","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swiftlang%2Frepo-templates/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swiftlang%2Frepo-templates/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swiftlang%2Frepo-templates/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/swiftlang","download_url":"https://codeload.github.com/swiftlang/repo-templates/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swiftlang%2Frepo-templates/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274039529,"owners_count":25211901,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-07T02:00:09.463Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-09-07T12:42:22.900Z","updated_at":"2025-09-07T12:42:24.716Z","avatar_url":"https://github.com/swiftlang.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# README Template \n\n## Instructions [to maintainer]\n- If a header doesn't make sense for your repo, remove it.\n- Fill in the [blanks] and answer the bullets questions, remove it if it's not necessary.\n- Remove this instructions section before committing the final version of the file.\n\n[Optional: Project Logo]\n\n## Name of Project\n\n[!IMPORTANT]\n[Optional: Critical notices about project status, pre-release warnings, or major changes, tags]\n\n[One-line description of what the project does and its primary value proposition]\n\n[Add relevant highlights according to the project]\n\u003c!-- Example\n🚀 Swift package for [what it does]\n📦 Compatible with Swift Package Manager\n📱 Supports Linux, Windows, iOS, macOS, watchOS, tvOS, and visionOS\n🔧 Built with Swift 5.7+, Xcode 15+\n--\u003e\n\n🔗 Jump to:\n- 📖 [Overview](#overview)\n- ⚙️ [Use Cases](#use-cases)\n- 📋 [Glossary](#glossary)\n- 🏁 [Getting Started](#getting-started)\n- 📘 [Documentation](#documentation)\n- 🧰 [Release Info](#release-info)\n- 💡 [Contributing](#contributing)\n- 🛠️ [Support](#support)\n- 🔐 [Security](#security)\n- 📄 [License](#license)\n\n## 📖 Overview\n[Provide a brief description of the repository, its purpose, and key features.]\n\n## ⚙️ Use Cases\n[List primary use cases and scenarios where this project shines. Include code snippets or real-world examples where helpful.]\n\n## 📋 Glossary\n[Explain important terms here that could mean other things in different projects or brand-new concepts/terms.]\n\n## 🏁 Getting Started\n\n### Prerequisites\n[List the tools, libraries, or environment setup needed to work with this repository. Include links, version requirements, or instructions for installation if necessary.]\n\u003c!-- EXAMPLE:\n- Swift version: [minimum Swift version required, e.g., Swift 5.0+]\n- Deployment targets if any:\n  - iOS: [minimum iOS version, e.g., iOS 17.0+]\n  - macOS: [minimum macOS version, e.g., macOS 14.0+]\n  - watchOS: [minimum watchOS version, e.g., watchOS 10.0+]\n  - tvOS: [minimum tvOS version, e.g., tvOS 17.0+]\n  - visionOS: [minimum visionOS version, e.g., visionOS 1.0+]\n- [Other tools or libraries required, e.g., Xcode 15.0+]\n- [Any additional dependencies with version requirements]\n- [Any system requirements or configuration needed]\n--\u003e\n\n### Installation / Integration\n[Clear instructions for those who want to use the project, **not contribute** to it]\n\n\u003c!-- Choose the relevant instructions depending on project type --\u003e\n\n\u003c!-- FOR SWIFT PACKAGES/LIBRARIES: --\u003e\n#### Adding as a Dependency\nTo use [Project Name] in your Swift project, add it as a dependency in your `Package.swift` file:\n\n```swift\ndependencies: [\n    .package(url: \"https://github.com/organization/project.git\", from: \"1.0.0\")\n]\n```\n\n\u003c!-- FOR OTHER PROJECT TYPES: --\u003e\n#### Setting Up [Project Name]\n\n[Provide step-by-step instructions to set up the repository locally.]\n\n[Include alternate installation methods if applicable]\n\n### Running the Project\n[Include instructions to build, test, or run the project.]\n\n### Usage\n\n[Provide minimal working example of how to use the project. Add code snippets or command-line examples as needed.]\n\n## 📘 Documentation\n\n\u003c!-- CHOOSE ONE OF THE FOLLOWING DOCUMENTATION SECTIONS BASED ON PROJECT TYPE --\u003e\n\u003c!-- FOR LIBRARIES/PACKAGES/FRAMEWORKS: \nDocumentation is hosted on the [Swift Package Index]($DOCS_URL) where you'll also find [tutorials]($DOCS_TUTORIALS_TOC_URL) and\nguides for using the project.\n--\u003e\n\u003c!-- Include relevant options --\u003e\n- [API Documentation](link-to-docs) - Complete API reference and guides\n- [Tutorials](link-to-tutorials) - Step-by-step guides for common use cases\n- [Examples](link-to-examples) - Sample projects demonstrating various features\n- [Configuration Guide](link-to-configuration) - Available settings and configuration options\n- [Troubleshooting](link-to-troubleshooting) - Common issues and solutions\n\n## 🧰 Release Info\n- Does this repo participate in the Swift release process? If not, get it detailed here about how many releases that users can expect a year and other details \n- Release Cadence: [Describe release schedule or process]\n- Version Compatibility: [Detail Swift/platform version requirements]\n- Migration Guides: [Link to upgrade guides between major versions]\n\n## 💡 Contributing\n\n`\u003c!-- Choose ONE of the following Contributing sections based on whether you have a project spect CONTRIBUTING.md file --\u003e`\n`\u003c!-- OPTION 1: For repos WITHOUT a custom CONTRIBUTING.md file --\u003e`  \nWe welcome contributions to [Project Name]! \n\nTo get started, please read the [Contributing Guide](https://www.swift.org/contributing/).\n\n`\u003c!-- OPTION 2: For repos WITH a custom CONTRIBUTING.md file --\u003e`  \nWe welcome contributions to [Project Name]! \n\nPlease see our [CONTRIBUTING.md](link) file for guidelines specific to this project.\n\n[If there are specific setup requirements for contributors that differ from users, include them here.]\n- [How to get started as a contributor]\n- [Development workflow]\n- [Coding guidelines]\n- [Pull request process]\n\n## 🛠️ Support\nIf you have any questions or need help, feel free to reach out by [opening an issue](https://github.com/swiftlang/[repository-name]/issues) or contacting the maintainers.\n\n- [GitHub Issues](link-to-issues) - Bug reports and feature requests\n- [Forums](link-to-forums) - General discussion and support\n- Team Contact: [@team-handle]\n- [link to CODEOWNERS] (if no CODEOWNERS, then provide a list of maintainer handles)\n\nThis repo is part of the [insert Workgroup or Steering Group name here]\n\n## 🔐 Security\nIf you discover a security vulnerability, please follow our [security policy](SECURITY.md) for responsible disclosure.\n\n## License\nThis project is licensed under the terms of the [LICENSE](URL to license)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswiftlang%2Frepo-templates","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fswiftlang%2Frepo-templates","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswiftlang%2Frepo-templates/lists"}