This repository has been archived by the owner on Jul 5, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 99
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rename and reorganize template.
- Loading branch information
Showing
3 changed files
with
38 additions
and
3 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 |
---|---|---|
@@ -1,3 +1,19 @@ | ||
# Contributing to the iOS Instructor Guides | ||
# How to Contribute | ||
|
||
TODO | ||
## Post an Issue | ||
|
||
If you discover a bug or error, please [add an issue](https://github.com/SwiftEducation/teaching-app-dev-swift/issues) here on GitHub. Feature requests are welcome. However, this is a community effort, so pull requests are preferred. | ||
|
||
## Create a Pull Request | ||
|
||
Fork the project, create a branch, commit your changes, and then create a pull request. Please submit your pull request to the **develop** branch of this repository. | ||
|
||
The **master** branch is for production-ready content and should not contain incomplete lessons. Development occurs on the **develop** branch. Once your pull request is accepted, it will be merged into **master**. | ||
|
||
## Impacts to Xcode Projects | ||
|
||
Please note that, because the lesson plans correspond with code in the various Xcode projects, you will likely need to submit an issue and/or pull request in the relevant repository for that Xcode project. [A full list of the Xcode project repositories can be seen here](http://github.com/SwiftEducation). | ||
|
||
## Creating New Lessons | ||
|
||
Please use the [Lesson Plan template](https://github.com/SwiftEducation/teaching-app-dev-swift/raw/master/Templates/Lesson%20Plan.template) to generate any lesson plans, so our work stays consistent. If you have an _entirely new_ app/project idea with accompanying lesson plans, please [post an issue](https://github.com/SwiftEducation/teaching-app-dev-swift/issues) or create a pull request. |
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 |
---|---|---|
@@ -1,2 +1,21 @@ | ||
# Teaching App Development with Swift | ||
## Instructor Guides & Lesson Plans | ||
|
||
First time seeing these materials? Visit the [Teaching App Development with Swift](http://swifteducation.github.io/teaching_app_development_with_swift/) site. | ||
|
||
This repository is for educators, students and developers to contribute feedback, ideas, corrections and new materials for [Teaching App Development with Swift](http://swifteducation.github.io/teaching_app_development_with_swift/). | ||
|
||
### Course Materials & Lesson Plans | ||
|
||
These [Pages](https://www.apple.com/mac/pages/) documents represent the source used to generate the PDFs for the [Teaching App Development with Swift](http://swifteducation.github.io/teaching_app_development_with_swift/) instructor materials. You are free to use these materials in accordance with the [license](LICENSE). | ||
|
||
[Teaching App Development with Swift](http://swifteducation.github.io/teaching_app_development_with_swift/) is a collection of instructor-facing materials to facilitate teachers in bringing [Swift](https://developer.apple.com/swift) and [app development](https://developer.apple.com/) into the classroom. Lessons are centered around different apps, and these materials reflect a hands-on, project-based pedagogy for experiential learning. | ||
|
||
To learn more, visit the [web site](http://swifteducation.github.io/teaching_app_development_with_swift/), and read the [Course Overview](http://swifteducation.github.io/assets/pdfs/CourseOverview.pdf) and [Lesson Plan Overview](http://swifteducation.github.io/assets/pdfs/LessonPlanOverview.pdf). | ||
|
||
## Contributing | ||
|
||
See [CONTRIBUTING.md](CONTRIBUTING.md). | ||
|
||
## License | ||
|
||
This work is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/), by Yong Bakos. |
File renamed without changes.