Skip to content

Commit 5c348a6

Browse files
authored
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`.
1 parent deae26e commit 5c348a6

9 files changed

Lines changed: 16 additions & 99 deletions

.licenseignore

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
.gitattributes
66
.git-blame-ignore-revs
77
.mailfilter
8-
.mailmap
98
.spi.yml
109
.swift-format
1110
.editorconfig
@@ -34,7 +33,6 @@ Makefile
3433
Dockerfile
3534
**/Dockerfile
3635
Snippets/*
37-
dev/git.commit.template
3836
dev/update-benchmark-thresholds
3937
*.crt
4038
**/*.crt

.mailmap

Lines changed: 0 additions & 6 deletions
This file was deleted.

CODE_OF_CONDUCT.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -45,28 +45,11 @@ Linux beefy.machine 4.4.0-101-generic #124-Ubuntu SMP Fri Nov 10 18:29:59 UTC 20
4545
My system has IPv6 disabled.
4646
```
4747

48-
## Writing a Patch
49-
50-
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.
51-
52-
A good SwiftLog patch is:
53-
54-
1. Concise, and contains as few changes as needed to achieve the end result.
55-
2. Tested, ensuring that any tests provided failed before the patch and pass after it.
56-
3. Documented, adding API documentation as needed to cover new functions and properties.
57-
4. Accompanied by a great commit message, using our commit message template.
58-
59-
### Commit Message Template
60-
61-
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:
62-
63-
git config commit.template dev/git.commit.template
64-
65-
### Make sure Tests work on Linux
48+
## Make sure Tests work on Linux
6649

6750
SwiftLog uses Swift Testing to run tests on all supported platforms.
6851

69-
### Run CI checks locally
52+
## Run CI checks locally
7053

7154
You can run the Github Actions workflows locally using
7255
[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
117100

118101
## How to contribute your work
119102

120-
Please open a pull request at https://github.com/apple/swift-log. Make sure the CI passes, and then wait for code review.
103+
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.
104+
105+
1. Prepare your change, keeping in mind that a good patch is:
106+
- Concise, and contains as few changes as needed to achieve the end result.
107+
- Tested, ensuring that any tests provided failed before the patch and pass after it.
108+
- Documented, adding API documentation as needed to cover new functions and properties.
109+
- Accompanied by a great commit message.
110+
2. Open a pull request at https://github.com/apple/swift-log and wait for code review by the maintainers.
121111

122112

123113
## Automated release process

CONTRIBUTORS.txt

Lines changed: 0 additions & 27 deletions
This file was deleted.

Package.swift

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,4 @@
11
// swift-tools-version:6.2
2-
//===----------------------------------------------------------------------===//
3-
//
4-
// This source file is part of the Swift Logging API open source project
5-
//
6-
// Copyright (c) 2018-2019 Apple Inc. and the Swift Logging API project authors
7-
// Licensed under Apache License v2.0
8-
//
9-
// See LICENSE.txt for license information
10-
// See CONTRIBUTORS.txt for the list of Swift Logging API project authors
11-
//
12-
// SPDX-License-Identifier: Apache-2.0
13-
//
14-
//===----------------------------------------------------------------------===//
152

163
import PackageDescription
174

Package@swift-6.1.swift

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,4 @@
11
// swift-tools-version:6.1
2-
//===----------------------------------------------------------------------===//
3-
//
4-
// This source file is part of the Swift Logging API open source project
5-
//
6-
// Copyright (c) 2018-2019 Apple Inc. and the Swift Logging API project authors
7-
// Licensed under Apache License v2.0
8-
//
9-
// See LICENSE.txt for license information
10-
// See CONTRIBUTORS.txt for the list of Swift Logging API project authors
11-
//
12-
// SPDX-License-Identifier: Apache-2.0
13-
//
14-
//===----------------------------------------------------------------------===//
152

163
import PackageDescription
174

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
# SwiftLog
22

3+
[![](https://img.shields.io/badge/docc-read_documentation-blue)](https://swiftpackageindex.com/apple/swift-log/documentation)
4+
[![](https://img.shields.io/github/v/release/apple/swift-log)](https://github.com/apple/swift-log/releases)
5+
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fapple%2Fswift-log%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/apple/swift-log)
6+
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fapple%2Fswift-log%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/apple/swift-log)
7+
38
This repository contains a logging API implementation for Swift.
49
SwiftLog provides a unified, performant, and ergonomic logging API that can be
510
adopted by libraries and applications across the Swift ecosystem.
611

712
- 📚 **Documentation** and **tutorials** are available on the [Swift Package Index](https://swiftpackageindex.com/apple/swift-log)
813
- 🚀 **Contributions** are welcome, please see [CONTRIBUTING.md](CONTRIBUTING.md)
914
- 🪪 **License** is Apache 2.0, repeated in [LICENSE.txt](LICENSE.txt)
10-
- 🔒 **Security** issues should be reported via the process in [SECURITY.md](SECURITY.md)
15+
- 🔒 **Security** issues should be reported via the process in [Security](https://github.com/apple/swift-log?tab=security-ov-file)
1116
- 🔀 **Available Logging Backends**: SwiftLog is an API package - you'll want to
1217
choose from the many
1318
[community-maintained logging backends](#available-log-handler-backends) for production use

dev/git.commit.template

Lines changed: 0 additions & 14 deletions
This file was deleted.

0 commit comments

Comments
 (0)