Contribution

Introduction

As part of our ongoing efforts to maintain consistency and ensure proper attribution across the Playbook Swift Design System, we have introduced a standard file header for all files within the repository. This document outlines the steps and guidelines for adding new files to the project, ensuring that each file adheres to our header attribution standard.

Prerequisites

Before contributing to the project, ensure you have the PlaybookSwift.xcworkspace file available. This workspace file is crucial for integrating your contributions seamlessly with the existing project structure.

Standard File Header

Each file you add to the project must include the following header at the top:

//
//  Playbook Swift Design System
//
//  Copyright © 2024 Power Home Remodeling Group
//  This software is distributed under the ISC License
//
//  FileName.swift

Replace FileName.swift with the actual name of your Swift file. This header serves multiple purposes: it identifies the project, marks the copyright ownership of Power Home Remodeling Group, specifies the license under which the software is distributed, and names the file for quick identification.

Adding New Files

When you add a new file to the project, follow these steps to ensure consistency with our project standards:

1. Open the Project: Start by opening PlaybookSwift.xcworkspace with Xcode. This ensures you're working within the correct project environment.

2. Create a New File: Use Xcode's file creation interface (File > New > File...) to add a new Swift file to the project. Choose the appropriate template for your needs, such as a Swift File, UIViewController subclass, etc.

3. Add the Standard Header: Before adding any code to your new file, insert the standard file header at the top. Make sure to replace FileName.swift with the name of your new file.

4. Write Your Code: After inserting the header, you can start writing your code. Ensure your code follows the project's coding standards and guidelines.

5. Commit Your Changes: Once you've added your new file and written your code, commit your changes to your fork or branch. Include a commit message that clearly describes the purpose and content of your contribution.

6. Submit a Pull Request: Finally, submit a pull request to the main repository. Your pull request should include a description of the changes and any other relevant information for the reviewers.

Conclusion

By following these guidelines, you help maintain the consistency and integrity of the Playbook Swift Design System project. If you have any questions or need further assistance, please reach out to the project maintainers. Thank you for your contributions and commitment to quality and consistency.