Initial commit, project structure

Author: ktoso

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,20 @@
+### Expected behavior
+_[what you expected to happen]_
+
+### Actual behavior
+_[what actually happened]_
+
+### Steps to reproduce
+
+1. ...
+2. ...
+
+### If possible, minimal yet complete reproducer code (or URL to code)
+
+_[anything to help us reproducing the issue]_
+
+### SwiftMetrics version/commit hash
+
+_[the SwiftMetrics tag/commit hash]_
+
+### Swift & OS version (output of `swift --version && uname -a`)

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+_[One line description of your change]_
+
+### Motivation:
+
+_[Explain here the context, and why you're making that change. What is the problem you're trying to solve.]_
+
+### Modifications:
+
+_[Describe the modifications you've done.]_
+
+### Result:
+
+_[After your change, what will change.]_

.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+/.build
+/Packages
+/*.xcodeproj
+.xcode
+.SourceKitten
+*.orig
+.swiftpm
+.idea

.mailmap

@@ -0,0 +1,2 @@
+Tomer Doron <[email protected]> <[email protected]> <[email protected]>
+Konrad `ktoso` Malawski <[email protected]> <[email protected]>

.swiftformat

@@ -0,0 +1,13 @@
+# file options
+
+--swiftversion 5.0
+--exclude .build
+
+# format options
+
+--self insert
+--patternlet inline
+--stripunusedargs unnamed-only
+--ifdef no-indent
+
+# rules

CODE_OF_CONDUCT.md

@@ -0,0 +1,55 @@
+# Code of Conduct
+To be a truly great community, SwiftMetrics needs to welcome developers from all walks of life,
+with different backgrounds, and with a wide range of experience. A diverse and friendly
+community will have more great ideas, more unique perspectives, and produce more great
+code. We will work diligently to make the SwiftMetrics community welcoming to everyone.
+
+To give clarity of what is expected of our members, SwiftMetrics has adopted the code of conduct
+defined by [contributor-covenant.org](https://www.contributor-covenant.org). This document is used across many open source
+communities, and we think it articulates our values well. The full text is copied below:
+
+### Contributor Code of Conduct v1.3
+As contributors and maintainers of this project, and in the interest of fostering an open and
+welcoming community, we pledge to respect all people who contribute through reporting
+issues, posting feature requests, updating documentation, submitting pull requests or patches,
+and other activities.
+
+We are committed to making participation in this project a harassment-free experience for
+everyone, regardless of level of experience, gender, gender identity and expression, sexual
+orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or
+nationality.
+
+Examples of unacceptable behavior by participants include:
+- The use of sexualized language or imagery
+- Personal attacks
+- Trolling or insulting/derogatory comments
+- Public or private harassment
+- Publishing other’s private information, such as physical or electronic addresses, without explicit permission
+- Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments,
+commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of
+Conduct, or to ban temporarily or permanently any contributor for other behaviors that they
+deem inappropriate, threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to fairly and
+consistently applying these principles to every aspect of managing this project. Project
+maintainers who do not follow or enforce the Code of Conduct may be permanently removed
+from the project team.
+
+This code of conduct applies both within project spaces and in public spaces when an
+individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
+contacting a project maintainer at [[email protected]](mailto:[email protected]). All complaints will be reviewed and
+investigated and will result in a response that is deemed necessary and appropriate to the
+circumstances. Maintainers are obligated to maintain confidentiality with regard to the reporter
+of an incident.
+
+*This policy is adapted from the Contributor Code of Conduct [version 1.3.0](https://contributor-covenant.org/version/1/3/0/).*
+
+### Reporting
+A working group of community members is committed to promptly addressing any [reported issues](mailto:[email protected]).
+Working group members are volunteers appointed by the project lead, with a
+preference for individuals with varied backgrounds and perspectives. Membership is expected
+to change regularly, and may grow or shrink.

CONTRIBUTING.md

@@ -0,0 +1,96 @@
+## Legal
+
+By submitting a pull request, you represent that you have the right to license
+your contribution to Apple and the community, and agree by submitting the patch
+that your contributions are licensed under the Apache 2.0 license (see
+`LICENSE.txt`).
+
+## How to submit a bug report
+
+Please ensure to specify the following:
+
+* SwiftMetrics commit hash
+* Contextual information (e.g. what you were trying to achieve with SwiftMetrics)
+* Simplest possible steps to reproduce
+  * More complex the steps are, lower the priority will be.
+  * A pull request with failing test case is preferred, but it's just fine to paste the test case into the issue description.
+* Anything that might be relevant in your opinion, such as:
+  * Swift version or the output of `swift --version`
+  * OS version and the output of `uname -a`
+  * Network configuration
+
+### Example
+
+```
+SwiftMetrics commit hash: b17a8a9f0f814c01a56977680cb68d8a779c951f
+
+Context:
+While testing my application that uses with SwiftMetrics, I noticed that ...
+
+Steps to reproduce:
+1. ...
+2. ...
+3. ...
+4. ...
+
+$ swift --version
+Swift version 4.0.2 (swift-4.0.2-RELEASE)
+Target: x86_64-unknown-linux-gnu
+
+Operating system: Ubuntu Linux 16.04 64-bit
+
+$ uname -a
+Linux beefy.machine 4.4.0-101-generic #124-Ubuntu SMP Fri Nov 10 18:29:59 UTC 2017 x86_64 x86_64 x86_64 GNU/Linux
+
+My system has IPv6 disabled.
+```
+
+## Writing a Patch
+
+A good SwiftMetrics patch is:
+
+1. Concise, and contains as few changes as needed to achieve the end result.
+2. Tested, ensuring that any tests provided failed before the patch and pass after it.
+3. Documented, adding API documentation as needed to cover new functions and properties.
+4. Accompanied by a great commit message, using our commit message template.
+
+### Commit Message Template
+
+We require that your commit messages match our template. The easiest way to do that is to get git to help you by explicitly using the template. To do that, `cd` to the root of our repository and run:
+
+    git config commit.template dev/git.commit.template
+
+### Make sure Tests work on Linux
+
+SwiftMetrics uses XCTest to run tests on both macOS and Linux. While the macOS version of XCTest is able to use the Objective-C runtime to discover tests at execution time, the Linux version is not.
+For this reason, whenever you add new tests **you have to run a script** that generates the hooks needed to run those tests on Linux, or our CI will complain that the tests are not all present on Linux. To do this, merely execute `ruby ./scripts/generate_linux_tests.rb` at the root of the package and check the changes it made.
+
+### Run `./scripts/sanity.sh`
+
+The scripts directory contains a [sanity.sh script](https://github.com/apple/swift-metrics/blob/main/scripts/sanity.sh) 
+that enforces additional checks, like license headers and formatting style.
+
+Please make sure to `./scripts/sanity.sh` before pushing a change upstream, otherwise it is likely the PR validation will fail
+on minor changes such as a missing `self.` or similar formatting issues.
+
+> The script also executes the above mentioned `generate_linux_tests.rb`.
+
+For frequent contributors, we recommend adding the script as a [git pre-push hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks), which you can do via executing the following command in the project root directory: 
+
+```bash
+cat << EOF > .git/hooks/pre-push
+#!/bin/bash
+
+if [[ -f "scripts/sanity.sh" ]]; then
+  scripts/sanity.sh
+fi
+EOF
+```
+
+Which makes the script execute, and only allow the `git push` to complete if the check has passed.
+
+In the case of formatting issues, you can then `git add` the formatting changes, and attempt the push again. 
+
+## How to contribute your work
+
+Please open a pull request at https://github.com/apple/swift-metrics. Make sure the CI passes, and then wait for code review.

CONTRIBUTORS.txt

@@ -0,0 +1,21 @@
+For the purpose of tracking copyright, this is the list of individuals and
+organizations who have contributed source code to the Swift Metrics API.
+
+For employees of an organization/company where the copyright of work done
+by employees of that company is held by the company itself, only the company
+needs to be listed here.
+
+## COPYRIGHT HOLDERS
+
+- Apple Inc. (all contributors with '@apple.com')
+
+### Contributors
+
+- Cory Benfield <[email protected]>
+- Jari (LotU) <[email protected]>
+- Konrad `ktoso` Malawski <[email protected]>
+- tomer doron <[email protected]>
+
+**Updating this list**
+
+Please do not edit this file manually. It is generated using `./scripts/generate_contributors_list.sh`. If a name is misspelled or appearing multiple times: add an entry in `./.mailmap`