Skip to content

Commit 4694e5c

Browse files
author
Jeff Ward
committed
Fix readme, add CONTRIBUTING.MD to match iOS
1 parent 6dc0e6a commit 4694e5c

File tree

3 files changed

+27
-4
lines changed

3 files changed

+27
-4
lines changed

.gitignore

+4-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,7 @@
77
/build
88
/captures
99
.externalNativeBuild
10-
.idea
10+
.idea
11+
*.project
12+
*.classpath
13+
*.prefs

CONTRIBUTING.md

+20-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
# How To Contribute
22

3+
Thank you for your interest in contributing to Hyperion. When contributing to Hyperion you will first want to make an [issue](https://github.com/willowtreeapps/Hyperion-Android/issues/new) so that we can discuss the change. Please follow our [code of conduct](CODE_OF_CONDUCT.md) when interacting with this project. If you find an existing issue that you want to fix, then claim it by assigning it to yourself. Once an issue has been discussed/approved:
4+
5+
1. Fork Hyperion.
6+
2. Clone your fork of Hyperion.
7+
3. Make changes and commit them.
8+
4. Push these changes up to your fork.
9+
5. Submit a pull request from your fork with the "base" being `willowtreeapps:develop` and then the "compare" being your branch.
10+
11+
Please follow [this guide](https://help.github.com/articles/fork-a-repo/) for more instruction on forking.
12+
313
### Hyperion Core
414

15+
It is crucial that any change made to HyperionCore does not break backwards compatibility with older plugins. This is why it is important to communicate any changes to HyperionCore with the owners via [issue](https://github.com/willowtreeapps/Hyperion-Android/issues/new).
16+
17+
### Hyperion Plugins
18+
19+
Most Hyperion plugins should go in their own repo. If you feel that there is a plugin that would be of use to the entire user base, please submit an issue and we will discuss whether it should go into the main repo. If your plugin is not a fit for the main repo, then you can still link to it in our [ReadMe.md](https://github.com/willowtreeapps/Hyperion-Android/blob/master/README.md#third-party-plugins) under the Third-Party Plugins section. Just submit a pull request with the change to the ReadMe and make the base `master`.
20+
21+
---
522

6-
### Hyperion Plugins
23+
By submitting a pull request, you represent that you have the right to license
24+
your contribution to WillowTree and the community, and agree by submitting the patch
25+
that your contributions are licensed under the [MIT License](LICENSE).

README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# Hyperion
22

3-
![Hyperion Logo](https://github.com/willowtreeapps/Hyperion-Android/art/Hyperion-Logo.png)
43
[![CircleCI](https://circleci.com/gh/willowtreeapps/Hyperion-Android.svg?style=svg&circle-token=3d0158d85c451692a4ce0ee18eb12617f67206eb)](https://circleci.com/gh/willowtreeapps/Hyperion-Android)
54
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.willowtreeapps.hyperion/hyperion-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.willowtreeapps.hyperion/hyperion-core)
65
[![License MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=flat)]()
76
[![Public Yes](https://img.shields.io/badge/Public-yes-green.svg?style=flat)]()
87

8+
[!Hyperion Logo](https://github.com/willowtreeapps/Hyperion-Android/art/Hyperion-Logo.png)
9+
910
# Hyperion - App Inspection Tool
1011

1112
## What is it?
@@ -72,7 +73,7 @@ Hyperion has adopted a [code of conduct](CODE_OF_CONDUCT.md) defined by the [Con
7273
Hyperion is available under the MIT license. See the LICENSE file for more info.
7374

7475
# About WillowTree!
75-
![WillowTree Logo](https://github.com/willowtreeapps/Hyperion-Android/art/willowtree_logo.png)
76+
[!WillowTree Logo](https://github.com/willowtreeapps/Hyperion-Android/art/willowtree_logo.png)
7677

7778
We build apps, responsive sites, bots—any digital product that lives on a screen—for the world’s leading companies. Our elite teams challenge themselves to build extraordinary experiences by bridging the latest strategy and design thinking with enterprise-grade software development.
7879

0 commit comments

Comments
 (0)