From 8bb0b3c4acfff19a1f2d253d140f1f4441ae20bc Mon Sep 17 00:00:00 2001 From: Paris Date: Tue, 9 Jun 2026 11:46:43 -0700 Subject: [PATCH 1/2] Revise CONTRIBUTING.md Worked on cleaning up and styling the guide with more actions and structure --- CONTRIBUTING.md | 37 +++++++++++++++++++++++++++++-------- 1 file changed, 29 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index abda1e1..da7a6df 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,20 +1,41 @@ -# Contributing +# Contributing to SwiftTLS -This project follows the [contribution guidelines for the Swift project](https://swift.org/contributing/#contributing-code). +Welcome to the community! Contributions are welcomed and encouraged. SwiftTLS is part of the Swift ecosystem and closely aligns with the [contribution guidelines for the Swift project](swift.org/contributing). -## Bug reports +## How You Can Help -We are using [GitHub Issues](https://github.com/apple/swift-tls/issues) for tracking bugs and other work. +* Reporting bugs with clear, reproducible steps via [GitHub Issues](https://github.com/apple/swift-tls/issues) +* Improving documentation to make the project more accessible +* Adding or enhancing tests to improve reliability and coverage +* Adding ports to new platforms +* Triaging issues by providing feedback, testing, and validation +* Participating in the [Networking category on the Swift Forums](https://forums.swift.org/c/development/networking/129) -## Pull requests +## Setting Up Your Environment + +See the [README](./README#building-and-testing) for prerequisites and build (and test) instructions. + +## Submitting Issues and Pull Requests + +### Issues and Bugs + +Use GitHub Issues to report bugs. When filing a bug, include your SwiftTLS version, Swift version, OS, and the simplest possible steps to reproduce. + +### Pull requests Each pull request will be reviewed by a code owner before merging. -* Pull requests should contain small, incremental changes. -* Focus on one task. If a pull request contains several unrelated commits, we will ask for the pull request to be split up. +* Pull requests should contain small, incremental changes focused on one task; we may ask you to split up the work. * Squash work-in-progress commits. Each commit should stand on its own (including the addition of tests if possible). This allows us to bisect issues more effectively. * After addressing review feedback, rebase your commit so that we create a clean history in the `main` branch. +* All code must conform to the [Swift API Design Guidelines](https://swift.org/documentation/api-design-guidelines/) +* Documentation is required. Please explain the "why" behind non-obvious decisions. + +Given SwiftTLS's limited scope, please confirm the fix or change via pull request is within scope by opening an [Issue](https://github.com/apple/swift-tls/issues) first. The [Networking category on the Swift Forums](https://forums.swift.org/c/development/networking/129) is also a great place to discuss feature requests and larger overall project discussions. ## Tests -Unit tests are run automatically on pull request creation and updates. All tests must pass on all supported platforms before merging pull requests. Pull requests that add new functionality should come with new automated tests. +All tests must pass on all supported platforms before a pull request can be merged. Unit tests are run automatically on pull request creation and updates. Pull requests that add new functionality should come with new automated tests. + +See the [README](./README#building-and-testing) for quick references + From bea9aa43a14047ece12a1b75f69bd78feac3a428 Mon Sep 17 00:00:00 2001 From: Tommy Pauly Date: Tue, 9 Jun 2026 13:46:58 -0700 Subject: [PATCH 2/2] Update CONTRIBUTING.md Co-authored-by: Paris --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index da7a6df..459a00f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,7 +31,7 @@ Each pull request will be reviewed by a code owner before merging. * All code must conform to the [Swift API Design Guidelines](https://swift.org/documentation/api-design-guidelines/) * Documentation is required. Please explain the "why" behind non-obvious decisions. -Given SwiftTLS's limited scope, please confirm the fix or change via pull request is within scope by opening an [Issue](https://github.com/apple/swift-tls/issues) first. The [Networking category on the Swift Forums](https://forums.swift.org/c/development/networking/129) is also a great place to discuss feature requests and larger overall project discussions. +Given SwiftTLS's [limited scope](./README#Contributing), please confirm the fix or change via pull request is within scope by opening an [Issue](https://github.com/apple/swift-tls/issues) first. The [Networking category on the Swift Forums](https://forums.swift.org/c/development/networking/129) is also a great place to discuss feature requests and larger overall project discussions. ## Tests