Skip to content

Commit

Permalink
feat: Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
showxu committed May 2, 2023
0 parents commit f76833e
Show file tree
Hide file tree
Showing 21 changed files with 2,095 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Lines starting with '#' are comments.
# Each line is a case-sensitive file pattern followed by one or more owners.
# Order is important. The last matching pattern has the most precedence.
# More information: https://docs.github.com/en/articles/about-code-owners
#
# Please mirror the repository's file hierarchy in case-sensitive lexicographic
# order.

# TODO: /.clang-format
# TODO: /.gitattributes

# .github
/.github @showxu
/.github/CODEOWNERS @showxu
/.github/ISSUE_TEMPLATE/ @showxu
/.github/PULL_REQUEST_TEMPLATE.md @showxu

# TODO: /.gitignore
# TODO: /CODE_OF_CONDUCT.md
# TODO: /CODE_OWNERS.TXT
# TODO: /CONTRIBUTING.md
# TODO: /LICENSE.txt
# TODO: /README.md

# Sources
/Sources @showxu

# Tests
/Tests @showxu

# Plugins
/Plugins @showxu
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
name: Bug report
about: Something isn't working as expected, create a report to help us improve.
title: ''
labels: bug, triage needed
assignees: ''
---

<!--
Thanks for contributing to the Swift Gyb!
Before you submit your issue, please replace each paragraph
below with the relevant details for your bug, and complete
the steps in the checklist by placing an 'x' in each box:
- [x] I've completed this task
- [ ] This task isn't completed
-->

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.

### Description
<!-- Describe clearly and concisely what the bug is. -->

### Checklist
- [ ] If possible, I've reproduced the issue using the `main` branch of this package
- [ ] I've searched for [existing GitHub issues](https://github.com/swift-library/swift-gyb/issues)

### Steps to Reproduce
<!--
Explain how to reproduce the problem (in steps if seen fit) and include either
an inline test case (preferred) or a project that reproduces it. Consider
reducing the sample to the smallest amount of code possible — a smaller test
case is easier to reason about and more appealing to сontributors.
-->

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.

### Expected behavior
<!-- Describe what you expected to happen. -->

<!-- If deemed helpful, add screenshots that showcase the problem. -->
<!-- **Screenshots** -->

<!--
Include information about the Swift compiler version and, if applicable, the
Xcode version you are observing the problem in and the deployment target.
-->

### Actual behavior
Describe or copy/paste the behavior you observe.

### Environment
- Swift compiler version info <!-- replace with the output of 'swiftc -version' -->
- Xcode version info <!-- replace with the output of 'xcodebuild -version' -->
- Deployment target: <!-- e.g. iOS 12.3 -->
- **Gyb version:** `0.0.1` or the `main` branch, for example.

<!-- Add any other context about the problem as appropriate. -->
<!-- **Additional context** -->
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
name: Feature Request
about: A suggestion for a new feature
title: ''
labels: feature, triage needed
assignees: ''
---

<!--
Thanks for contributing to the Swift Gyb!
Before you submit your issue, please replace the paragraph
below with information about your proposed feature.
If you haven't found or started a thread on the Swift Gyb yet, consider
socializing your idea in the "Discussion"
(https://github.com/orgs/swift-library/discussions) after submitting this request.
While GitHub issues do great for tracking
purposes, the forums are far better ground for drawing attention to ideas and
gauging interest from the community.
-->

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.

### Motivation
<!-- Describe the problem that your feature seeks to address. -->

### Solution
<!--
Describe your solution to the problem. Provide examples and describe how
they work.
-->

### Alternatives considered
<!--
Describe any alternative approaches or features that you have considered in
addressing the problem, and why you chose this approach instead.
-->

<!--
Add any other context about your feature as appropriate. For example, link out
to a discussion on the Swift forums (https://forums.swift.org).
-->
<!-- **Additional context** -->
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Discussion
url: https://github.com/orgs/swift-library/discussions
about: Questions about using Swift Gyb? Ask here!
29 changes: 29 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!--
Thanks for contributing to the Swift Gyb!
If this pull request adds new API, please add '?template=new.md'
to the URL to switch to the appropriate template.
Before you submit your request, please replace the paragraph
below with the relevant details, and complete the steps in the
checklist by placing an 'x' in each box:
- [x] I've completed this task
- [ ] This task isn't completed
-->

<!-- What's in this pull request? -->
Replace this paragraph with a description of your changes and rationale. Provide links to an existing issue or external references/discussions, if appropriate.

<!--
If this pull request resolves any GitHub issues, link them.
For information about linking a pull request to an issue, see:
https://docs.github.com/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue
-->
Resolves #NNNNN, fix swift-library/swift-gyb#MMMMM.

### Checklist
- [ ] I've added at least one test that validates that my change is working, if appropriate
- [ ] I've followed the code style of the rest of the project
- [ ] I've read the [Contribution Guidelines](https://github.com/swift-library/swift-gyb/blob/main/CONTRIBUTING.md)
- [ ] I've updated the documentation if necessary
36 changes: 36 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/NEW.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<!--
Thanks for contributing to the Swift Gyb!
Before you submit your request, please replace each paragraph
below with the relevant details, and complete the steps in the
checklist by placing an 'x' in each box:
- [x] I've completed this task
- [ ] This task isn't completed
-->

### Description
Replace this paragraph with a description of your changes and rationale. Provide links to an existing issue or external references/discussions, if appropriate.

### Detailed Design
Include any additional information about the design here. At minimum, show any new API:

```swift
/// The new feature implemented by this pull request.
struct NewFeature {}
```

### Documentation Plan
How has the new feature been documented? Have the relevant portions of the guide been updated in addition to symbol-level documentation?

### Test Plan
How is the new feature tested?

### Source Impact
What is the impact of this change on existing users? Does it deprecate or remove any existing API?

### Checklist
- [ ] I've added at least one test that validates that my change is working, if appropriate
- [ ] I've followed the code style of the rest of the project
- [ ] I've read the [Contribution Guidelines](https://github.com/swift-library/swift-gyb/blob/main/CONTRIBUTING.md)
- [ ] I've updated the documentation if necessary
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.DS_Store
/.build
/Packages
/*.xcodeproj
xcuserdata/
DerivedData/
.swiftpm/config/registries.json
.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
.netrc
5 changes: 5 additions & 0 deletions .spi.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
version: 1
builder:
configs:
- documentation_targets: [Gyb, GybExample]

23 changes: 23 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# CHANGELOG

> **Note**\
> This is in reverse chronological order, so newer entries are added to the top.
<!--
Add new items at the end of the relevant section under **Unreleased**.
-->

## [Unreleased]

*No changes yet.*

---

## [0.0.1] - 2023-05-02

- `swift-gyb` initial release.

<!-- Link references for releases -->

[Unreleased]: https://github.com/swift-library/swift-gyb/compare/0.0.1...HEAD
[0.0.1]: https://github.com/swift-library/swift-gyb/releases/tag/0.0.1
55 changes: 55 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Code of Conduct
To be a truly great community, swift-library community 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 swift-library community welcoming to everyone.

To give clarity of what is expected of our members, swift-library community 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 [swift-library-conduct@gmail.com](mailto:swift-library-conduct@gmail.com).
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](http://contributor-covenant.org/version/1/3/0/).*

### Reporting
A working group of community members is committed to promptly addressing any [reported
issues](mailto:swift-library-conduct@gmail.com). 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.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
By submitting a pull request, you represent that you have the right to license
your contribution to swift-library project, and agree by submitting the patch
that your contributions are licensed under the [swift-library
license](https://swift-library.github.io/LICENSE.txt).

---

Before submitting the pull request, please make sure you have tested your
changes and that they follow the Swift project [guidelines for contributing
code](https://swift-library.github.io/contributing/#contributing-code).
Loading

0 comments on commit f76833e

Please sign in to comment.