mirror of
https://github.com/apple/swift-log
synced 2026-11-22 03:40:39 +00:00
Cleanup repository structure (#451)
Unify repos layout across the ecosystem: 1. Remove `CONTRIBUTORS.md` and mentions of it. 2. Remove `CODE_OF_CONDUCT.md` and mentions of it. 3. From `CONTRIBUTING.md` remove "Writing a Patch" and "Commit Message Template" sections. 4. Remove `.mailmap` and mentions of it. 5. Remove `dev/git.commit.template` and mentions of it. 6. Remove `SECURITY.md`, if it is referenced somewhere, change it to reference to the org security file "https://github.com/apple/swift-log?tab=security-ov-file". 7. Remove copyright header from `Package.swift` and version-specific package manifests. 8. Add SPI shields to the `README.md`. 9. Add "How to contribute your work" section in `CONTRIBUTING.md`. 10. Add "Add Automated release process" section in `CONTRIBUTING.md`.
This commit is contained in:
1 parent
deae26e91a
commit
5c348a629c
9 files changed
+16
-99
No files matched your search
@@ -5,7 +5,6 @@
|
||||
.gitattributes
|
||||
.git-blame-ignore-revs
|
||||
.mailfilter
|
||||
.mailmap
|
||||
.spi.yml
|
||||
.swift-format
|
||||
.editorconfig
|
||||
@@ -34,7 +33,6 @@ Makefile
|
||||
Dockerfile
|
||||
**/Dockerfile
|
||||
Snippets/*
|
||||
dev/git.commit.template
|
||||
dev/update-benchmark-thresholds
|
||||
*.crt
|
||||
**/*.crt
|
||||
|
||||
@@ -1,6 +0,0 @@
|
||||
Tomer Doron <tomer@apple.com> <tomer.doron@gmail.com>
|
||||
Tomer Doron <tomer@apple.com> tomer doron <tomer@apple.com>
|
||||
Tomer Doron <tomer@apple.com> tomer doron <tomerd@apple.com>
|
||||
Johannes Weiss <johannesweiss@apple.com> <johannes@jweiss.io>
|
||||
Max Moiseev <moiseev@apple.com> <moiseev@users.noreply.github.com>
|
||||
Konrad `ktoso` Malawski <ktoso@apple.com> <konrad.malawski@project13.pl>
|
||||
@@ -1,3 +0,0 @@
|
||||
# Code of Conduct
|
||||
|
||||
The code of conduct for this project can be found at https://swift.org/code-of-conduct.
|
||||
+10
-20
@@ -45,28 +45,11 @@ Linux beefy.machine 4.4.0-101-generic #124-Ubuntu SMP Fri Nov 10 18:29:59 UTC 20
|
||||
My system has IPv6 disabled.
|
||||
```
|
||||
|
||||
## Writing a Patch
|
||||
|
||||
For non-trivial changes that affect the public API, it is good practice to have a discussion phase before writing code. Please follow the [proposal process](Sources/Logging/Docs.docc/Proposals/Proposals.md) to gather feedback and align on the approach with other contributors.
|
||||
|
||||
A good SwiftLog 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
|
||||
## Make sure Tests work on Linux
|
||||
|
||||
SwiftLog uses Swift Testing to run tests on all supported platforms.
|
||||
|
||||
### Run CI checks locally
|
||||
## Run CI checks locally
|
||||
|
||||
You can run the Github Actions workflows locally using
|
||||
[act](https://github.com/nektos/act). To run all the jobs that run on a pull
|
||||
@@ -117,7 +100,14 @@ For more information please refer to `swift package benchmark --help` or the [do
|
||||
|
||||
## How to contribute your work
|
||||
|
||||
Please open a pull request at https://github.com/apple/swift-log. Make sure the CI passes, and then wait for code review.
|
||||
For non-trivial changes that affect the public API, it is good practice to have a discussion phase before writing code. Please follow the [proposal process](Sources/Logging/Docs.docc/Proposals/Proposals.md) to gather feedback and align on the approach with other contributors.
|
||||
|
||||
1. Prepare your change, keeping in mind that a good patch is:
|
||||
- Concise, and contains as few changes as needed to achieve the end result.
|
||||
- Tested, ensuring that any tests provided failed before the patch and pass after it.
|
||||
- Documented, adding API documentation as needed to cover new functions and properties.
|
||||
- Accompanied by a great commit message.
|
||||
2. Open a pull request at https://github.com/apple/swift-log and wait for code review by the maintainers.
|
||||
|
||||
|
||||
## Automated release process
|
||||
|
||||
@@ -1,27 +0,0 @@
|
||||
For the purpose of tracking copyright, this is the list of individuals and
|
||||
organizations who have contributed source code to the Swift Logging 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
|
||||
|
||||
- David Hart <david@hartbit.com>
|
||||
- Iain Smith <iainsmith@users.noreply.github.com>
|
||||
- Ian Partridge <i.partridge@uk.ibm.com>
|
||||
- Johannes Weiss <johannesweiss@apple.com>
|
||||
- Kevin Sweeney <kevin.t.sweeney@gmail.com>
|
||||
- Konrad `ktoso` Malawski <ktoso@apple.com>
|
||||
- Max Moiseev <moiseev@apple.com>
|
||||
- Tanner <me@tanner.xyz>
|
||||
- Thomas Krajacic <tkrajacic@users.noreply.github.com>
|
||||
- Tomer Doron <tomer@apple.com>
|
||||
|
||||
**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`
|
||||
@@ -1,17 +1,4 @@
|
||||
// swift-tools-version:6.2
|
||||
//===----------------------------------------------------------------------===//
|
||||
//
|
||||
// This source file is part of the Swift Logging API open source project
|
||||
//
|
||||
// Copyright (c) 2018-2019 Apple Inc. and the Swift Logging API project authors
|
||||
// Licensed under Apache License v2.0
|
||||
//
|
||||
// See LICENSE.txt for license information
|
||||
// See CONTRIBUTORS.txt for the list of Swift Logging API project authors
|
||||
//
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
import PackageDescription
|
||||
|
||||
|
||||
@@ -1,17 +1,4 @@
|
||||
// swift-tools-version:6.1
|
||||
//===----------------------------------------------------------------------===//
|
||||
//
|
||||
// This source file is part of the Swift Logging API open source project
|
||||
//
|
||||
// Copyright (c) 2018-2019 Apple Inc. and the Swift Logging API project authors
|
||||
// Licensed under Apache License v2.0
|
||||
//
|
||||
// See LICENSE.txt for license information
|
||||
// See CONTRIBUTORS.txt for the list of Swift Logging API project authors
|
||||
//
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
import PackageDescription
|
||||
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# SwiftLog
|
||||
|
||||
[](https://swiftpackageindex.com/apple/swift-log/documentation)
|
||||
[](https://github.com/apple/swift-log/releases)
|
||||
[](https://swiftpackageindex.com/apple/swift-log)
|
||||
[](https://swiftpackageindex.com/apple/swift-log)
|
||||
|
||||
This repository contains a logging API implementation for Swift.
|
||||
SwiftLog provides a unified, performant, and ergonomic logging API that can be
|
||||
adopted by libraries and applications across the Swift ecosystem.
|
||||
@@ -7,7 +12,7 @@ adopted by libraries and applications across the Swift ecosystem.
|
||||
- 📚 **Documentation** and **tutorials** are available on the [Swift Package Index](https://swiftpackageindex.com/apple/swift-log)
|
||||
- 🚀 **Contributions** are welcome, please see [CONTRIBUTING.md](CONTRIBUTING.md)
|
||||
- 🪪 **License** is Apache 2.0, repeated in [LICENSE.txt](LICENSE.txt)
|
||||
- 🔒 **Security** issues should be reported via the process in [SECURITY.md](SECURITY.md)
|
||||
- 🔒 **Security** issues should be reported via the process in [Security](https://github.com/apple/swift-log?tab=security-ov-file)
|
||||
- 🔀 **Available Logging Backends**: SwiftLog is an API package - you'll want to
|
||||
choose from the many
|
||||
[community-maintained logging backends](#available-log-handler-backends) for production use
|
||||
|
||||
@@ -1,14 +0,0 @@
|
||||
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.
|
||||
Reference in new issue
Block a user