feat(swift): generate CONTRIBUTING.md for Swift SDKs

generators/swift/sdk/changes/unreleased/add-contributing-md.yml

@@ -0,0 +1,3 @@
+- summary: |
+    Generate CONTRIBUTING.md for Swift SDKs.
+  type: feat

generators/swift/sdk/src/SdkGeneratorCli.ts

@@ -16,6 +16,7 @@ import { FernGeneratorExec } from "@fern-fern/generator-exec-sdk";
 import { FernIr } from "@fern-fern/ir-sdk";
 import { template as templateFn } from "lodash-es";
 
+import { ContributingGenerator } from "./contributing/ContributingGenerator.js";
 import {
     PackageSwiftGenerator,
     RootClientGenerator,
@@ -69,6 +70,9 @@ export class SdkGeneratorCLI extends AbstractSwiftGeneratorCli<SdkCustomConfigSc
     protected async generate(context: SdkGeneratorContext): Promise<void> {
         await this.generateSourceFiles(context);
         await Promise.all([this.generateRootFiles(context), this.generateTestFiles(context)]);
+        if (!context.config.whitelabel) {
+            this.generateContributing(context);
+        }
         await context.project.persist();
     }
 
@@ -134,6 +138,12 @@ export class SdkGeneratorCLI extends AbstractSwiftGeneratorCli<SdkCustomConfigSc
         }
     }
 
+    private generateContributing(context: SdkGeneratorContext): void {
+        const contributingGenerator = new ContributingGenerator();
+        const content = contributingGenerator.generate();
+        context.project.addRootFiles(new File("CONTRIBUTING.md", RelativeFilePath.of(""), content));
+    }
+
     private generateSnippets(
         dynamicIr: FernIr.dynamic.DynamicIntermediateRepresentation,
         snippetsGenerator: DynamicSnippetsGenerator

generators/swift/sdk/src/__test__/ContributingGenerator.test.ts

@@ -0,0 +1,60 @@
+import { describe, expect, it } from "vitest";
+
+import { ContributingGenerator } from "../contributing/ContributingGenerator.js";
+
+describe("ContributingGenerator", () => {
+    it("generates CONTRIBUTING.md with Swift commands", () => {
+        const generator = new ContributingGenerator();
+        const result = generator.generate();
+        expect(result).toContain("swift build");
+        expect(result).toContain("swift test");
+        expect(result).toContain("swift format");
+        expect(result).toContain("swiftformat .");
+        expect(result).toContain("swiftlint");
+    });
+
+    it("includes all expected sections", () => {
+        const generator = new ContributingGenerator();
+        const result = generator.generate();
+        expect(result).toContain("# Contributing");
+        expect(result).toContain("## Getting Started");
+        expect(result).toContain("### Prerequisites");
+        expect(result).toContain("### Installation");
+        expect(result).toContain("### Building");
+        expect(result).toContain("### Testing");
+        expect(result).toContain("### Formatting");
+        expect(result).toContain("### Linting");
+        expect(result).toContain("## About Generated Code");
+        expect(result).toContain("## Making Changes");
+        expect(result).toContain("## Questions or Issues?");
+        expect(result).toContain("## License");
+    });
+
+    it("includes Fern-specific information", () => {
+        const generator = new ContributingGenerator();
+        const result = generator.generate();
+        expect(result).toContain("Fern");
+        expect(result).toContain(".fernignore");
+        expect(result).toContain("buildwithfern.com");
+        expect(result).toContain("github.com/fern-api/fern");
+    });
+
+    it("references Swift generator path", () => {
+        const generator = new ContributingGenerator();
+        const result = generator.generate();
+        expect(result).toContain("generators/swift/");
+    });
+
+    it("includes Swift prerequisites", () => {
+        const generator = new ContributingGenerator();
+        const result = generator.generate();
+        expect(result).toContain("Swift 5.9+");
+        expect(result).toContain("Swift Package Manager");
+    });
+
+    it("generates full content snapshot", () => {
+        const generator = new ContributingGenerator();
+        const result = generator.generate();
+        expect(result).toMatchSnapshot();
+    });
+});

generators/swift/sdk/src/__test__/__snapshots__/ContributingGenerator.test.ts.snap

@@ -0,0 +1,134 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`ContributingGenerator > generates full content snapshot 1`] = `
+"# Contributing
+
+Thanks for your interest in contributing to this SDK! This document provides guidelines for contributing to the project.
+
+## Getting Started
+
+### Prerequisites
+
+- Swift 5.9+
+- Swift Package Manager
+
+### Installation
+
+Install the project dependencies:
+
+\`\`\`bash
+swift package resolve
+\`\`\`
+
+### Building
+
+Build the project:
+
+\`\`\`bash
+swift build
+\`\`\`
+
+### Testing
+
+Run the test suite:
+
+\`\`\`bash
+swift test
+\`\`\`
+
+### Formatting
+
+Format the code:
+
+\`\`\`bash
+swift format .
+\`\`\`
+
+Or using SwiftFormat:
+
+\`\`\`bash
+swiftformat .
+\`\`\`
+
+### Linting
+
+Lint the code:
+
+\`\`\`bash
+swiftlint
+\`\`\`
+
+## About Generated Code
+
+**Important**: Most files in this SDK are automatically generated by [Fern](https://buildwithfern.com) from the API definition. Direct modifications to generated files will be overwritten the next time the SDK is generated.
+
+### Generated Files
+
+The following directories contain generated code:
+- \`Sources/\` - API client classes and types
+- Most Swift files in the project
+
+### How to Customize
+
+If you need to customize the SDK, you have two options:
+
+#### Option 1: Use \`.fernignore\`
+
+For custom code that should persist across SDK regenerations:
+
+1. Create a \`.fernignore\` file in the project root
+2. Add file patterns for files you want to preserve (similar to \`.gitignore\` syntax)
+3. Add your custom code to those files
+
+Files listed in \`.fernignore\` will not be overwritten when the SDK is regenerated.
+
+For more information, see the [Fern documentation on custom code](https://buildwithfern.com/learn/sdks/overview/custom-code).
+
+#### Option 2: Contribute to the Generator
+
+If you want to change how code is generated for all users of this SDK:
+
+1. The Swift SDK generator lives in the [Fern repository](https://github.com/fern-api/fern)
+2. Generator code is located at \`generators/swift/\`
+3. Follow the [Fern contributing guidelines](https://github.com/fern-api/fern/blob/main/CONTRIBUTING.md)
+4. Submit a pull request with your changes to the generator
+
+This approach is best for:
+- Bug fixes in generated code
+- New features that would benefit all users
+- Improvements to code generation patterns
+
+## Making Changes
+
+### Workflow
+
+1. Create a new branch for your changes
+2. Make your modifications
+3. Run tests to ensure nothing breaks: \`swift test\`
+4. Run formatting: \`swift format .\` or \`swiftformat .\`
+5. Run linting: \`swiftlint\`
+6. Build the project: \`swift build\`
+7. Commit your changes with a clear commit message
+8. Push your branch and create a pull request
+
+### Commit Messages
+
+Write clear, descriptive commit messages that explain what changed and why.
+
+### Code Style
+
+This project uses automated code formatting and linting. Run \`swift format .\` or \`swiftformat .\` before committing to ensure your code meets the project's style guidelines.
+
+## Questions or Issues?
+
+If you have questions or run into issues:
+
+1. Check the [Fern documentation](https://buildwithfern.com)
+2. Search existing [GitHub issues](https://github.com/fern-api/fern/issues)
+3. Open a new issue if your question hasn't been addressed
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under the same license as the project.
+"
+`;

generators/swift/sdk/src/contributing/ContributingGenerator.ts

@@ -0,0 +1,134 @@
+export class ContributingGenerator {
+    public generate(): string {
+        return `# Contributing
+
+Thanks for your interest in contributing to this SDK! This document provides guidelines for contributing to the project.
+
+## Getting Started
+
+### Prerequisites
+
+- Swift 5.9+
+- Swift Package Manager
+
+### Installation
+
+Install the project dependencies:
+
+\`\`\`bash
+swift package resolve
+\`\`\`
+
+### Building
+
+Build the project:
+
+\`\`\`bash
+swift build
+\`\`\`
+
+### Testing
+
+Run the test suite:
+
+\`\`\`bash
+swift test
+\`\`\`
+
+### Formatting
+
+Format the code:
+
+\`\`\`bash
+swift format .
+\`\`\`
+
+Or using SwiftFormat:
+
+\`\`\`bash
+swiftformat .
+\`\`\`
+
+### Linting
+
+Lint the code:
+
+\`\`\`bash
+swiftlint
+\`\`\`
+
+## About Generated Code
+
+**Important**: Most files in this SDK are automatically generated by [Fern](https://buildwithfern.com) from the API definition. Direct modifications to generated files will be overwritten the next time the SDK is generated.
+
+### Generated Files
+
+The following directories contain generated code:
+- \`Sources/\` - API client classes and types
+- Most Swift files in the project
+
+### How to Customize
+
+If you need to customize the SDK, you have two options:
+
+#### Option 1: Use \`.fernignore\`
+
+For custom code that should persist across SDK regenerations:
+
+1. Create a \`.fernignore\` file in the project root
+2. Add file patterns for files you want to preserve (similar to \`.gitignore\` syntax)
+3. Add your custom code to those files
+
+Files listed in \`.fernignore\` will not be overwritten when the SDK is regenerated.
+
+For more information, see the [Fern documentation on custom code](https://buildwithfern.com/learn/sdks/overview/custom-code).
+
+#### Option 2: Contribute to the Generator
+
+If you want to change how code is generated for all users of this SDK:
+
+1. The Swift SDK generator lives in the [Fern repository](https://github.com/fern-api/fern)
+2. Generator code is located at \`generators/swift/\`
+3. Follow the [Fern contributing guidelines](https://github.com/fern-api/fern/blob/main/CONTRIBUTING.md)
+4. Submit a pull request with your changes to the generator
+
+This approach is best for:
+- Bug fixes in generated code
+- New features that would benefit all users
+- Improvements to code generation patterns
+
+## Making Changes
+
+### Workflow
+
+1. Create a new branch for your changes
+2. Make your modifications
+3. Run tests to ensure nothing breaks: \`swift test\`
+4. Run formatting: \`swift format .\` or \`swiftformat .\`
+5. Run linting: \`swiftlint\`
+6. Build the project: \`swift build\`
+7. Commit your changes with a clear commit message
+8. Push your branch and create a pull request
+
+### Commit Messages
+
+Write clear, descriptive commit messages that explain what changed and why.
+
+### Code Style
+
+This project uses automated code formatting and linting. Run \`swift format .\` or \`swiftformat .\` before committing to ensure your code meets the project's style guidelines.
+
+## Questions or Issues?
+
+If you have questions or run into issues:
+
+1. Check the [Fern documentation](https://buildwithfern.com)
+2. Search existing [GitHub issues](https://github.com/fern-api/fern/issues)
+3. Open a new issue if your question hasn't been addressed
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under the same license as the project.
+`;
+    }
+}