-
Notifications
You must be signed in to change notification settings - Fork 82
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Migrate to DocC for API reference docs (#257)
We currently use Swift Doc to generate the API reference documentation site, which was deprecated after Apple announced their fancy documentation generator at WWDC 2021 called DocC. In addition to producing great looking content pages, DocC supports arbitrary markdown formatted articles, interactive tutorials, and works well with SwiftPM packages. DocC’s feature set makes it easy to consolidate our existing documentation, which is scattered across the README, GitHub wiki, and API reference site. There are several benefits as well, including searchability (Google doesn’t index GitHub wiki pages) and the ability to decouple the README contents from releases.
- Loading branch information
1 parent
f498ab3
commit b491852
Showing
480 changed files
with
7,000 additions
and
54,837 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Contributing to Mockingbird | ||
|
||
## Getting Started | ||
|
||
Welcome! We’re excited to have you as part of the Mockingbird developer community. | ||
|
||
- [Join the #mockingbird Slack channel](https://join.slack.com/t/birdopensource/shared_invite/zt-wogxij50-3ZM7F8ZxFXvPkE0j8xTtmw) | ||
- [Check out the GitHub tasks board](https://github.com/birdrides/mockingbird/projects/2) | ||
- [Search for good first issues](https://github.com/birdrides/mockingbird/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) | ||
|
||
## Issues and Bugs | ||
|
||
Before opening an issue, please search the [existing GitHub issues](https://github.com/birdrides/mockingbird/issues) and list of [common problems](https://mockingbirdswift.com/common-problems). Use one of the provided issue templates so that others have sufficient context to fix the issue. | ||
|
||
## Feature Requests | ||
|
||
Submit feature requests as a [GitHub issue](https://github.com/birdrides/mockingbird/issues/new/choose), using the provided “Feature Request” template. | ||
|
||
## Pull Requests | ||
|
||
Use the provided “Pull Request” template when submitting pull requests. If making a change to codegen or the testing runtime, make sure to update the end-to-end and/or framework tests. | ||
|
||
All pull requests are squash-merged into `master`. For large or complex changes, consider creating a stacked pull request and joining the [#mockingbird Slack channel](https://join.slack.com/t/birdopensource/shared_invite/zt-wogxij50-3ZM7F8ZxFXvPkE0j8xTtmw) to facilitate discussion. | ||
|
||
## Coding Guidelines | ||
|
||
Mockingbird loosely follows [Google’s Swift style guide](https://google.github.io/swift/). When in doubt, prefer consistency with existing conventions in the code. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
name: Feature Request | ||
about: Submit a new feature request | ||
title: '' | ||
labels: 'enhancement' | ||
assignees: '' | ||
|
||
--- | ||
|
||
## New Feature Request Checklist | ||
|
||
- [ ] I searched the [existing GitHub feature requests](https://github.com/birdrides/mockingbird/labels/enhancement) | ||
|
||
## Overview | ||
|
||
The expected behavior and use case. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
name: Framework Issue | ||
about: Report a problem with the testing framework | ||
title: '' | ||
labels: 'framework bug' | ||
assignees: '' | ||
|
||
--- | ||
|
||
## New Issue Checklist | ||
|
||
- [ ] I updated the framework and generator to the latest version | ||
- [ ] I searched the [existing GitHub issues](https://github.com/birdrides/mockingbird/issues) and list of [common problems](https://mockingbirdswift.com/common-problems) | ||
|
||
## Overview | ||
|
||
A summary of the issue. | ||
|
||
## Example | ||
|
||
A minimal example of the code being tested along with the test case. | ||
|
||
## Expected Behavior | ||
|
||
If needed, provide a short description of how it should work. | ||
|
||
## Environment | ||
|
||
* Mockingbird CLI version (`mockingbird version`) | ||
* Xcode and Swift version (`swift --version`) | ||
* Package manager (CocoaPods, Carthage, SPM project, SPM package) | ||
* Unit testing framework (XCTest, Quick/Nimble) | ||
* Custom configuration | ||
- [ ] Mockingbird ignore files | ||
- [ ] Supporting source files |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
name: Generator Issue | ||
about: Report a problem with the code generator | ||
title: '' | ||
labels: 'generator bug' | ||
assignees: '' | ||
|
||
--- | ||
|
||
## New Issue Checklist | ||
|
||
- [ ] I updated the framework and generator to the latest version | ||
- [ ] I searched the [existing GitHub issues](https://github.com/birdrides/mockingbird/issues) and list of [common problems](https://mockingbirdswift.com/common-problems) | ||
|
||
## Overview | ||
|
||
A summary of the issue. | ||
|
||
## Example | ||
|
||
If the generator produces code that is malformed or does not compile, please provide: | ||
|
||
1. A minimal example of the original source | ||
2. The actual mocking code generated | ||
|
||
If the generator is not producing code or crashing, please provide the build logs. | ||
|
||
## Expected Behavior | ||
|
||
If needed, provide a short description of how it should work. | ||
|
||
## Environment | ||
|
||
* Mockingbird CLI version (`mockingbird version`) | ||
* Xcode and Swift version (`swift --version`) | ||
* Package manager (CocoaPods, Carthage, SPM project, SPM package) | ||
* Unit testing framework (XCTest, Quick/Nimble) | ||
* Custom configuration | ||
- [ ] Mockingbird ignore files | ||
- [ ] Supporting source files |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
name: Pull Request | ||
about: Submit a new pull request | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Overview | ||
|
||
The motivation for making this change, what it does, and any additional considerations. | ||
|
||
## Test Plan | ||
|
||
Demonstrate that the code is solid. For example, commands that you ran and their output. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -49,5 +49,8 @@ Packages/ | |
.swiftpm/ | ||
/Package.resolved | ||
|
||
## DocC | ||
.docc-build | ||
|
||
## macOS | ||
.DS_Store |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.