Skip to content

Commit 01a030a

Browse files
add contributing guide
1 parent 6a2bf96 commit 01a030a

File tree

3 files changed

+21
-0
lines changed

3 files changed

+21
-0
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Contributing to the Typewriter Modes project
2+
3+
You're very welcome to suggest, change, adapt, and replace anything you like in a pull request! If you want to propose a dramatic change, please open an issue first for discussion before making a pull request, though. Because discussions in PRs often get messy easily.
4+
5+
That being said, the usual guidelines apply:
6+
7+
* fork this repository,
8+
* commit changes to a new branch in your fork,
9+
* create a pull request from your branch to this repository's `master`.

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,12 @@ I explain the parts in blog posts instead of making the readme even longer:
5252
* [Overscrolling](http://cleancocoa.com/posts/2017/07/typewriter-mode-overscrolling/)
5353

5454

55+
## Contributing
56+
57+
There's still work to do to make all typewriter modes a pleasant experience. I'd love to see you involved!
58+
59+
For technical details, have a look at the [Contributing Guide](/CONTRIBUTING.md).
60+
5561
## License
5662

5763
Copyright (c) 2017 Christian Tietze. Distributed under the MIT License.

Typewriter.xcodeproj/project.pbxproj

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@
2121
/* End PBXBuildFile section */
2222

2323
/* Begin PBXFileReference section */
24+
507C47FC1F189D13009D43E3 /* LICENSE */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = LICENSE; sourceTree = "<group>"; };
25+
507C47FD1F189D13009D43E3 /* README.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = "<group>"; };
26+
507C48001F189F38009D43E3 /* CONTRIBUTING.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = net.daringfireball.markdown; path = CONTRIBUTING.md; sourceTree = "<group>"; };
2427
5086C1BE1F15FAEA007A2D75 /* TypewriterMode.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TypewriterMode.swift; sourceTree = "<group>"; };
2528
5086C1C01F15FB05007A2D75 /* BottomOverscrollFlexibleTypewriterMode.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = BottomOverscrollFlexibleTypewriterMode.swift; sourceTree = "<group>"; };
2629
5086C1C21F15FBC0007A2D75 /* FullOverscrollFlexibleTypewriterMode.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = FullOverscrollFlexibleTypewriterMode.swift; sourceTree = "<group>"; };
@@ -50,6 +53,9 @@
5053
50CBA4731F0A35760092E8ED = {
5154
isa = PBXGroup;
5255
children = (
56+
507C47FD1F189D13009D43E3 /* README.md */,
57+
507C48001F189F38009D43E3 /* CONTRIBUTING.md */,
58+
507C47FC1F189D13009D43E3 /* LICENSE */,
5359
50CBA47E1F0A35760092E8ED /* Typewriter */,
5460
50CBA47D1F0A35760092E8ED /* Products */,
5561
);

0 commit comments

Comments
 (0)