Skip to content

Commit

Permalink
Doc Update: CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ppraveentr committed Aug 6, 2021
1 parent dae0a42 commit 5a7b991
Show file tree
Hide file tree
Showing 6 changed files with 97 additions and 2 deletions.
34 changes: 34 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Contributing to MobileCore

We want to make contributing to this project as easy and transparent as possible. Here are a few guidelines for making all our lives easier.

## Reporting Issues

A great way to contribute to the project is to send a detailed issue when you encounter an problem.
It is very important to check for the same problem or suggestion in the project's issue list first. If you find a match, just add a small comment there.
Doing this helps prioritize the most common problems and requests.

When reporting issues, please include the following:

- The platform name and version (e.g. iOS 13)
- The application version or commit hash
- The version of Xcode you're using
- The full output of any stack trace or compiler error
- Any other details that would be useful in understanding the problem

This information will help us review and fix your issue faster.

Please do not be offended if we close your issue and reference this document.
If you believe the issue is truly a fault in the project’s codebase, re-open it.

## Pull Requests

We gladly accept any PR's assuming they are well written, documented ( if necessary ) and preferably have test code.
If you're unsure if we'll accept a new feature please open an issue requesting it and we can have a discussion before you code and submit a PR.

Checklist:
- Fork the repo and create your branch from the latest master (to minimize the conflicts)
- If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints (swiftlint).
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!--
ℹ Please fill out this template when filing an issue. All lines beginning with an ℹ symbol instruct you with what info we expect.
Please, read the [CONTRIBUTING guide](https://github.com/ppraveentr/MobileCore/blob/master/.github/CONTRIBUTING.md) before submitting the PR or reporting a bug.
-->

# Report

## What did you do?

ℹ Please replace this with what you did.

## What did you expect to happen?

ℹ Please replace this with what you expected to happen.

## What happened instead?

ℹ Please replace this with of what happened instead.
10 changes: 10 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!--
If your pull request fixes an issue, please reference the issue.
For example, when your pull request fixes issue 10, add the following line:
Fixes #10
This will make sure that when the pull request is merged, we can close the relavent issue accordingly.
Please, read the [CONTRIBUTING guide](https://github.com/ppraveentr/MobileCore/blob/master/.github/CONTRIBUTING.md) before submitting the PR or reporting a bug.
-->
31 changes: 31 additions & 0 deletions .github/stale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@

# Configuration for probot-stale - https://github.com/probot/stale

# Number of days of inactivity before an Issue or Pull Request becomes stale
daysUntilStale: 30

# Number of days of inactivity before a stale Issue or Pull Request is closed
daysUntilClose: 7

# Issues or Pull Requests with these labels will never be considered stale
exemptLabels:
- "enhancement"
- "confirmed bug"

# Label to use when marking as stale
staleLabel: stale

# Comment to post when marking as stale. Set to `false` to disable
markComment: >
This issue has been marked as stale because it has not had
recent activity. It will be closed if no further activity occurs.
# Comment to post when removing the stale label. Set to `false` to disable
unmarkComment: false

# Comment to post when closing a stale Issue or Pull Request. Set to `false` to disable
closeComment: >
This issue has been auto-closed because there hasn't been any activity for at least 37 days.
However, we really appreciate your contribution, so thank you for that! 🙏
Also, feel free to [open a new issue]https://github.com/ppraveentr/MobileCore/issues/new) if you still experience this problem 👍.
# Limit to only `issues`
only: issues
4 changes: 2 additions & 2 deletions Example/MobileCoreExample.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@
DE9221D31EF28CDF000C8FC7 /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Assets.xcassets; sourceTree = "<group>"; };
DE9221D61EF28CDF000C8FC7 /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/LaunchScreen.storyboard; sourceTree = "<group>"; };
DE9221D81EF28CDF000C8FC7 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
DE9FF335269F406D0020E855 /* workflows */ = {isa = PBXFileReference; lastKnownFileType = folder; name = workflows; path = ../.github/workflows; sourceTree = "<group>"; };
DE9FF336269F413C0020E855 /* Gemfile */ = {isa = PBXFileReference; lastKnownFileType = text; name = Gemfile; path = ../Gemfile; sourceTree = "<group>"; };
DE9FF337269F414E0020E855 /* fastlane */ = {isa = PBXFileReference; lastKnownFileType = folder; name = fastlane; path = ../fastlane; sourceTree = "<group>"; };
DEB664C426B6763000A18E47 /* .github */ = {isa = PBXFileReference; lastKnownFileType = folder; name = .github; path = ../.github; sourceTree = "<group>"; };
DEBDC8931EF4508900AC77A9 /* MobileCoreExample-Bridging-Header.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "MobileCoreExample-Bridging-Header.h"; sourceTree = "<group>"; };
DEBDC8A21EF4520100AC77A9 /* MobileCoreExample.entitlements */ = {isa = PBXFileReference; lastKnownFileType = text.plist.entitlements; path = MobileCoreExample.entitlements; sourceTree = "<group>"; };
DEF68499269AEE3A00215BFE /* .swiftlint.yml */ = {isa = PBXFileReference; lastKnownFileType = text.yaml; name = .swiftlint.yml; path = ../.swiftlint.yml; sourceTree = "<group>"; };
Expand Down Expand Up @@ -134,11 +134,11 @@
D49FE30E2345D2A4002B3742 /* CI-CD Setup */ = {
isa = PBXGroup;
children = (
DEB664C426B6763000A18E47 /* .github */,
DE63A3A826A416BF003DE96D /* Package.swift */,
D47590162317A68A00080D78 /* MobileCore.podspec */,
DE9FF336269F413C0020E855 /* Gemfile */,
DE9FF337269F414E0020E855 /* fastlane */,
DE9FF335269F406D0020E855 /* workflows */,
D49FE3132345D2FC002B3742 /* .gitignore */,
DEF68499269AEE3A00215BFE /* .swiftlint.yml */,
D49FE30F2345D2F1002B3742 /* .codecov.yml */,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,5 +105,6 @@ public extension UINavigationBar {
UINavigationBar.appearance(whenContainedInInstancesOf: [UINavigationController.self])

navigationBar.barTintColor = color
navigationBar.tintColor = color
}
}

0 comments on commit 5a7b991

Please sign in to comment.