From d90893e9a0171f78f3b692dbc1ae6c07720a8639 Mon Sep 17 00:00:00 2001 From: Tommy <79723996+Tommygithubaccount123@users.noreply.github.com> Date: Thu, 3 Aug 2023 10:10:34 -0700 Subject: [PATCH] Add CONTRIBUTING.md? (#575) * Create contribute.md * Update CONTRIBUTING.md Co-Authored-By: Fedor Korotkov * Update CONTRIBUTING.md Co-authored-by: Fedor Korotkov * Update CONTRIBUTING.md Co-authored-by: Fedor Korotkov * missing ''' --------- Co-authored-by: Fedor Korotkov --- CONTRIBUTING.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..63ed874 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# Contributing to Tart + +Table of Contents +----------------- + +- [How to Build](#how-to-build) +- [How to Create an Issue/Enhancement](#how-to-create-an-issueenhancement) +- [Style Guidelines](#style-guidelines) +- [Pull Requests](#Pull-Requests) + +## How to Build + +1. Fork the repository to your own GitHub account +2. Clone the forked repository to your local machine +3. If using Xcode, use from Xcode 15 or newer +4. Run ./scripts/run-signed.sh from the root of your repository + +```bash +./scripts/run-signed.sh list +``` +## How to Create an Issue/Enhancement + +1. Go to the [Issue page](https://github.com/cirruslabs/tart/issues) of the repository +2. Click on the "New Issue" button +3. Provide a descriptive title and detailed description of the issue or enhancement you're suggesting +4. Submit the issue + +## Style Guidelines + +1. Code should follow camel case +2. Code should follow [SwiftFormat](https://github.com/nicklockwood/SwiftFormat#swift-package-manager-plugin) guidelines. You can auto-format the code by running the following command: +```bash +swift package plugin --allow-writing-to-package-directory swiftformat --cache ignore . +``` + +## Pull Requests + +1. Provide a detailed description of the changes you made in the pull request +2. Wait for pull request to be reviewed +3. Make adjustments if necessary