Skip to content

Commit f76833e

Browse files
showxushowxu
committed
feat: Initial commit
0 parents  commit f76833e

21 files changed

+2095
-0
lines changed

‎.github/CODEOWNERS

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Lines starting with '#' are comments.
2+
# Each line is a case-sensitive file pattern followed by one or more owners.
3+
# Order is important. The last matching pattern has the most precedence.
4+
# More information: https://docs.github.com/en/articles/about-code-owners
5+
#
6+
# Please mirror the repository's file hierarchy in case-sensitive lexicographic
7+
# order.
8+
9+
# TODO: /.clang-format
10+
# TODO: /.gitattributes
11+
12+
# .github
13+
/.github @showxu
14+
/.github/CODEOWNERS @showxu
15+
/.github/ISSUE_TEMPLATE/ @showxu
16+
/.github/PULL_REQUEST_TEMPLATE.md @showxu
17+
18+
# TODO: /.gitignore
19+
# TODO: /CODE_OF_CONDUCT.md
20+
# TODO: /CODE_OWNERS.TXT
21+
# TODO: /CONTRIBUTING.md
22+
# TODO: /LICENSE.txt
23+
# TODO: /README.md
24+
25+
# Sources
26+
/Sources @showxu
27+
28+
# Tests
29+
/Tests @showxu
30+
31+
# Plugins
32+
/Plugins @showxu

‎.github/ISSUE_TEMPLATE/BUG_REPORT.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
name: Bug report
3+
about: Something isn't working as expected, create a report to help us improve.
4+
title: ''
5+
labels: bug, triage needed
6+
assignees: ''
7+
---
8+
9+
<!--
10+
Thanks for contributing to the Swift Gyb!
11+
12+
Before you submit your issue, please replace each paragraph
13+
below with the relevant details for your bug, and complete
14+
the steps in the checklist by placing an 'x' in each box:
15+
16+
- [x] I've completed this task
17+
- [ ] This task isn't completed
18+
-->
19+
20+
Replace this paragraph with a short description of the incorrect incorrect behavior. If this is a regression, please note the last version that the behavior was correct in addition to your current version.
21+
22+
### Description
23+
<!-- Describe clearly and concisely what the bug is. -->
24+
25+
### Checklist
26+
- [ ] If possible, I've reproduced the issue using the `main` branch of this package
27+
- [ ] I've searched for [existing GitHub issues](https://github.com/swift-library/swift-gyb/issues)
28+
29+
### Steps to Reproduce
30+
<!--
31+
Explain how to reproduce the problem (in steps if seen fit) and include either
32+
an inline test case (preferred) or a project that reproduces it. Consider
33+
reducing the sample to the smallest amount of code possible — a smaller test
34+
case is easier to reason about and more appealing to сontributors.
35+
-->
36+
37+
Replace this paragraph with an explanation of how to reproduce the incorrect behavior. This could include a code listing for a reduced version of your command, or a link to the code that is exhibiting the issue.
38+
39+
### Expected behavior
40+
<!-- Describe what you expected to happen. -->
41+
42+
<!-- If deemed helpful, add screenshots that showcase the problem. -->
43+
<!-- **Screenshots** -->
44+
45+
<!--
46+
Include information about the Swift compiler version and, if applicable, the
47+
Xcode version you are observing the problem in and the deployment target.
48+
-->
49+
50+
### Actual behavior
51+
Describe or copy/paste the behavior you observe.
52+
53+
### Environment
54+
- Swift compiler version info <!-- replace with the output of 'swiftc -version' -->
55+
- Xcode version info <!-- replace with the output of 'xcodebuild -version' -->
56+
- Deployment target: <!-- e.g. iOS 12.3 -->
57+
- **Gyb version:** `0.0.1` or the `main` branch, for example.
58+
59+
<!-- Add any other context about the problem as appropriate. -->
60+
<!-- **Additional context** -->

‎.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Feature Request
3+
about: A suggestion for a new feature
4+
title: ''
5+
labels: feature, triage needed
6+
assignees: ''
7+
---
8+
9+
<!--
10+
Thanks for contributing to the Swift Gyb!
11+
12+
Before you submit your issue, please replace the paragraph
13+
below with information about your proposed feature.
14+
15+
If you haven't found or started a thread on the Swift Gyb yet, consider
16+
socializing your idea in the "Discussion"
17+
(https://github.com/orgs/swift-library/discussions) after submitting this request.
18+
While GitHub issues do great for tracking
19+
purposes, the forums are far better ground for drawing attention to ideas and
20+
gauging interest from the community.
21+
22+
-->
23+
24+
Replace this paragraph with a description of your proposed feature. Code samples that show what's missing, or what new capabilities will be possible, are very helpful! Provide links to existing issues or external references/discussions, if appropriate.
25+
26+
### Motivation
27+
<!-- Describe the problem that your feature seeks to address. -->
28+
29+
### Solution
30+
<!--
31+
Describe your solution to the problem. Provide examples and describe how
32+
they work.
33+
-->
34+
35+
### Alternatives considered
36+
<!--
37+
Describe any alternative approaches or features that you have considered in
38+
addressing the problem, and why you chose this approach instead.
39+
-->
40+
41+
<!--
42+
Add any other context about your feature as appropriate. For example, link out
43+
to a discussion on the Swift forums (https://forums.swift.org).
44+
-->
45+
<!-- **Additional context** -->

‎.github/ISSUE_TEMPLATE/config.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Discussion
4+
url: https://github.com/orgs/swift-library/discussions
5+
about: Questions about using Swift Gyb? Ask here!

‎.github/PULL_REQUEST_TEMPLATE.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<!--
2+
Thanks for contributing to the Swift Gyb!
3+
4+
If this pull request adds new API, please add '?template=new.md'
5+
to the URL to switch to the appropriate template.
6+
7+
Before you submit your request, please replace the paragraph
8+
below with the relevant details, and complete the steps in the
9+
checklist by placing an 'x' in each box:
10+
11+
- [x] I've completed this task
12+
- [ ] This task isn't completed
13+
-->
14+
15+
<!-- What's in this pull request? -->
16+
Replace this paragraph with a description of your changes and rationale. Provide links to an existing issue or external references/discussions, if appropriate.
17+
18+
<!--
19+
If this pull request resolves any GitHub issues, link them.
20+
For information about linking a pull request to an issue, see:
21+
https://docs.github.com/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue
22+
-->
23+
Resolves #NNNNN, fix swift-library/swift-gyb#MMMMM.
24+
25+
### Checklist
26+
- [ ] I've added at least one test that validates that my change is working, if appropriate
27+
- [ ] I've followed the code style of the rest of the project
28+
- [ ] I've read the [Contribution Guidelines](https://github.com/swift-library/swift-gyb/blob/main/CONTRIBUTING.md)
29+
- [ ] I've updated the documentation if necessary

‎.github/PULL_REQUEST_TEMPLATE/NEW.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<!--
2+
Thanks for contributing to the Swift Gyb!
3+
4+
Before you submit your request, please replace each paragraph
5+
below with the relevant details, and complete the steps in the
6+
checklist by placing an 'x' in each box:
7+
8+
- [x] I've completed this task
9+
- [ ] This task isn't completed
10+
-->
11+
12+
### Description
13+
Replace this paragraph with a description of your changes and rationale. Provide links to an existing issue or external references/discussions, if appropriate.
14+
15+
### Detailed Design
16+
Include any additional information about the design here. At minimum, show any new API:
17+
18+
```swift
19+
/// The new feature implemented by this pull request.
20+
struct NewFeature {}
21+
```
22+
23+
### Documentation Plan
24+
How has the new feature been documented? Have the relevant portions of the guide been updated in addition to symbol-level documentation?
25+
26+
### Test Plan
27+
How is the new feature tested?
28+
29+
### Source Impact
30+
What is the impact of this change on existing users? Does it deprecate or remove any existing API?
31+
32+
### Checklist
33+
- [ ] I've added at least one test that validates that my change is working, if appropriate
34+
- [ ] I've followed the code style of the rest of the project
35+
- [ ] I've read the [Contribution Guidelines](https://github.com/swift-library/swift-gyb/blob/main/CONTRIBUTING.md)
36+
- [ ] I've updated the documentation if necessary

‎.gitignore

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.DS_Store
2+
/.build
3+
/Packages
4+
/*.xcodeproj
5+
xcuserdata/
6+
DerivedData/
7+
.swiftpm/config/registries.json
8+
.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
9+
.netrc

‎.spi.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
version: 1
2+
builder:
3+
configs:
4+
- documentation_targets: [Gyb, GybExample]
5+

‎CHANGELOG.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# CHANGELOG
2+
3+
> **Note**\
4+
> This is in reverse chronological order, so newer entries are added to the top.
5+
6+
<!--
7+
Add new items at the end of the relevant section under **Unreleased**.
8+
-->
9+
10+
## [Unreleased]
11+
12+
*No changes yet.*
13+
14+
---
15+
16+
## [0.0.1] - 2023-05-02
17+
18+
- `swift-gyb` initial release.
19+
20+
<!-- Link references for releases -->
21+
22+
[Unreleased]: https://github.com/swift-library/swift-gyb/compare/0.0.1...HEAD
23+
[0.0.1]: https://github.com/swift-library/swift-gyb/releases/tag/0.0.1

‎CODE_OF_CONDUCT.md

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

‎CONTRIBUTING.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
By submitting a pull request, you represent that you have the right to license
2+
your contribution to swift-library project, and agree by submitting the patch
3+
that your contributions are licensed under the [swift-library
4+
license](https://swift-library.github.io/LICENSE.txt).
5+
6+
---
7+
8+
Before submitting the pull request, please make sure you have tested your
9+
changes and that they follow the Swift project [guidelines for contributing
10+
code](https://swift-library.github.io/contributing/#contributing-code).

0 commit comments

Comments
 (0)