Skip to content

Commit f1d7120

Browse files
committed
Added CONTRIBUTING.md
1 parent efd3f33 commit f1d7120

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

CONTRIBUTING.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# How to Contribute
2+
Thanks for taking the time to read this! As this is a hobby project for me, I don't always have the time to keep ForecastIO up to date. I try my best, but any additional help from anyone willing to contribute is very much appreciated!
3+
4+
## Coding Style
5+
Take a look at the code that's already been written as a definitive guide. Comments are highly encouraged, and appledoc style is used to autogenerate documentation.
6+
7+
## Source Control & Pull Requests
8+
The commit history for ForecastIO isn't the cleanest or even close to perfect, but I try to stick to a few general rules. The `master` branch is used for public releases, and each release commit is tagged with the version. Active development occurs on the `dev` branch. Once a set of commits for a feature are complete on the `dev` branch, I'll squash and merge them onto the `master` branch to keep it clean. Please send all pull requests directly to the `dev` branch. I'll review them there and make any changes that may be needed. After that, I'll merge them into `master` for a new release.
9+
10+
## Unit Tests
11+
I'm proud to say that ForecastIO has 100% code coverage with unit tests! I'd like to keep it this way, and the library is pretty small so I don't think it'll be difficult to do. I highly encourage you to include unit tests with any code that you submit if applicable. Take a look at the unit tests that have already been written for a guide to write your own.
12+
13+
Thanks!
14+
Satyam
15+

ForecastIO.xcodeproj/project.pbxproj

+2
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,7 @@
151151
4A3640F91D150EAA005602A7 /* CHANGELOG.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = CHANGELOG.md; sourceTree = "<group>"; };
152152
4A468FF41D9A0AAF00B2C0D2 /* ForecastIOError.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = ForecastIOError.swift; path = Source/ForecastIOError.swift; sourceTree = "<group>"; };
153153
4A7AFEA31D98B9BA00568802 /* Result.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = Result.swift; path = Source/Result.swift; sourceTree = "<group>"; };
154+
4A7C1CD2206FFBBD0021A961 /* CONTRIBUTING.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = CONTRIBUTING.md; sourceTree = "<group>"; };
154155
4A8B23511D447FB300ACBAA8 /* ForecastIO iOS Tests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = "ForecastIO iOS Tests.xctest"; sourceTree = BUILT_PRODUCTS_DIR; };
155156
4AB7086C1D45230F005D1E8E /* LanguageTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = LanguageTests.swift; path = Tests/LanguageTests.swift; sourceTree = SOURCE_ROOT; };
156157
4AB708701D45246C005D1E8E /* IconTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = IconTests.swift; path = Tests/IconTests.swift; sourceTree = SOURCE_ROOT; };
@@ -348,6 +349,7 @@
348349
D4B85DAD1C533A7B00BD2FCD /* LICENSE */,
349350
D4B85DAE1C533A7B00BD2FCD /* README.md */,
350351
4A3640F91D150EAA005602A7 /* CHANGELOG.md */,
352+
4A7C1CD2206FFBBD0021A961 /* CONTRIBUTING.md */,
351353
BA6428E9F66FD5A23C0A2E06ED26CD2F /* Podfile */,
352354
);
353355
name = Metadata;

0 commit comments

Comments
 (0)