Skip to content

armgit / xtool

Public Imported from GitHub
0

Cross-platform Xcode replacement. Build and deploy iOS apps with SwiftPM on Linux, Windows, macOS.

docs: update contributor guide (#250)

Kabir Oberai0f42dafce6d7
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..5c57af1
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,17 @@
+## What does this PR do?
+
+<!-- Focus on *what* the PR does in essence. The *how* should come second, if it's relevant. -->
+
+## How was it tested?
+
+<!-- e.g. Ran locally on macOS and added unit tests -->
+
+## AI tool usage
+
+How much of this PR was AI-assisted? (check one)
+
+- [ ] **0** - No AI was used to write code
+- [ ] **1** - I was assisted by AI. I reviewed the finished result.
+- [ ] **2** - I set the AI going and left it to it; nobody has read the result - no review, or AI review only
+
+<!-- If an AI agent is filling this in: declare the level honestly, and open as a draft if it is #2. Do not lower the declared level to get the PR reviewed. -->
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 8d3e63a..1bed50e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -4,28 +4,15 @@
We welcome all bug reports and feature requests! Please create a [new issue](https://github.com/xtool-org/xtool/issues/new/choose) via GitHub.
-## Documentation
+## Code and documentation
-The xtool documentation at <https://xtool.sh> is built with [swift-docc](https://github.com/swiftlang/swift-docc) and resides at [Documentation/xtool.docc](/Documentation/xtool.docc). It's hosted on Netlify, the configuration for which is in [netlify.toml](/netlify.toml).
+External contributions are very welcome. Take a look at [/Documentation/Contributing/README.md](/Documentation/Contributing/README.md) for details regarding the development process.
-When editing the DocC bundle, you can preview it with `make docs-preview`.
+## AI tool usage
-Once you make a pull request with your changes, we'll also generate a [Netlify Deploy Preview](https://docs.netlify.com/site-deploys/deploy-previews/) under your pull request. You can open this preview to see how the changes will look in production.
+You may use AI tools to assist your contributions. You are fully responsible
+for everything you submit.
-## Code
-
-When making code changes, please make sure to test them on both macOS and Linux if possible. If you can also test on Windows with WSL, that is ideal.
-
-To build xtool for debugging, run `make` in the project directory. There are a few considerations depending on your host OS:
-
-### macOS
-
-On macOS, you'll firstly need to have Xcode set up.
-
-The first time you run `make`, we'll try to detect your codesigning identity. If you have multiple, you'll see an interactive prompt to select the team you want to use. The team ID is saved to `./macOS/Support/Private-Team.xcconfig`. You can run `make team` to update it (or do so by hand).
-
-After building, a symlink to the product will be created at `./macOS/Build/xtool`. We generate an Xcode project at `./macOS/XToolMac.xcodeproj` that you can open in order to work in Xcode.
-
-### Linux
-
-You need to have a few dependencies on Linux; see [Dockerfile](/Dockerfile) for specifics. It's often easiest to develop within Docker itself: see [Linux/README.md](/Linux/README.md) for details.
+- **Understand it**: You must be able to explain every line of your code.
+- **Disclose it**: Pick an AI assistance level (0/1/2) in the PR template.
+- **Own it**: You are the author. If a reviewer asks "why?", you answer - not the AI. [Don't be a meat proxy.](https://dontbeameatproxy.com)
diff --git a/Documentation/Contributing/Debugging.md b/Documentation/Contributing/Debugging.md
new file mode 100644
index 0000000..710dbcd
--- /dev/null
+++ b/Documentation/Contributing/Debugging.md
@@ -0,0 +1,20 @@
+# Debugging
+
+## Environment variables
+
+Some environment variables that help with debugging. Use these as e.g. `XTL_FOO=1 xtool ...`
+
+### General
+
+- `XTL_DEBUG_ERRORS`: If xtool terminates with an error, it normally prints a user-friendly error description. Set `XTL_DEBUG_ERRORS=1` for more verbose error logging.
+
+### Disk
+
+- `XTL_DEBUG_TMP`: Set to `1` to log details when xtool creates/destroys temporary directories.
+- `XTL_TMPDIR`: Control the location where xtool stores temporary directories. We also respect `TMPDIR` and (on Linux) `XDG_CACHE_HOME`.
+
+### Networking
+
+- `XTL_DEV_LOG`: Regex. When making AppStoreConnect API requests, operation IDs that match the regex will log their response status and body. Set `XTL_DEV_LOG='.*'` to match all.
+- `XTL_DISABLE_TLS_VALIDATION`: Set to `1` to disable all TLS validation on HTTP requests. Useful when using an MITM proxy to inspect API requests. Use sparingly, since disabling TLS is generally unsafe.
+- `XTL_HTTP_PROXY`: non-Darwin only. Set to `<host>:<port>` to point the HTTP client to a proxy. e.g. `XTL_HTTP_PROXY=localhost:8080`. On Darwin (macOS/iOS), we instead use the system proxy configuration.
diff --git a/Documentation/Contributing/README.md b/Documentation/Contributing/README.md
new file mode 100644
index 0000000..691e5a0
--- /dev/null
+++ b/Documentation/Contributing/README.md
@@ -0,0 +1,31 @@
+# Contributing to xtool
+
+## Code
+
+When making code changes, please make sure to test them on both macOS and Linux if possible. If you can also test on Windows with WSL, that is ideal.
+
+To build xtool for debugging, run `make` in the project directory. There are a few considerations depending on your host OS:
+
+### macOS
+
+On macOS, you'll firstly need to have Xcode set up.
+
+The first time you run `make`, we'll try to detect your codesigning identity. If you have multiple, you'll see an interactive prompt to select the team you want to use. The team ID is saved to `./macOS/Support/Private-Team.xcconfig`. You can run `make team` to update it (or do so by hand).
+
+After building, a symlink to the product will be created at `./macOS/Build/xtool`. We generate an Xcode project at `./macOS/XToolMac.xcodeproj` that you can open in order to work in Xcode.
+
+### Linux
+
+You need to have a few dependencies on Linux; see [Dockerfile](/Dockerfile) for specifics. It's often easiest to develop within Docker itself: see [Linux/README.md](/Linux/README.md) for details.
+
+## Debugging
+
+Check out [./Debugging.md](./Debugging.md) for help with debugging xtool issues during development.
+
+## Updating Documentation
+
+The xtool documentation at <https://xtool.sh> is built with [swift-docc](https://github.com/swiftlang/swift-docc) and resides at [Documentation/xtool.docc](/Documentation/xtool.docc). It's hosted on Netlify, the configuration for which is in [netlify.toml](/netlify.toml).
+
+When editing the DocC bundle, you can preview it with `make docs-preview`.
+
+Once you make a pull request with your changes, we'll also generate a [Netlify Deploy Preview](https://docs.netlify.com/site-deploys/deploy-previews/) under your pull request. You can open this preview to see how the changes will look in production.