-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Squashed 'src/github.com/TheRealBill/redskull/' content from commit c…
…67469b git-subtree-dir: src/github.com/TheRealBill/redskull git-subtree-split: c67469b5f43ba191c1cac9f5156aa6598b9525c4
- Loading branch information
0 parents
commit 4b941fc
Showing
701 changed files
with
116,360 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Compiled Object files, Static and Dynamic libs (Shared Objects) | ||
*.o | ||
*.a | ||
*.so | ||
|
||
# Folders | ||
_obj | ||
_test | ||
|
||
# Architecture specific extensions/prefixes | ||
*.[568vq] | ||
[568vq].out | ||
|
||
*.cgo1.go | ||
*.cgo2.c | ||
_cgo_defun.c | ||
_cgo_gotypes.go | ||
_cgo_export.* | ||
|
||
_testmain.go | ||
|
||
*.exe | ||
*.test | ||
*.prof | ||
|
||
# Vim | ||
*.swp | ||
*.swo |
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 |
---|---|---|
@@ -0,0 +1,129 @@ | ||
# contributing to RedSkull | ||
|
||
This is a short guide on contributing to RedSkull. It will be fleshed out as | ||
lessons are learned. | ||
|
||
# Basic Process | ||
|
||
From a functional standpoint this is on Github so clone the repository, create | ||
a dedicated branch, make changes, merge from upstream, validate code, | ||
submit PR, and finally stop making changes unless needed to address issues, | ||
questions, concerns, etc.. | ||
|
||
## Git Setup | ||
|
||
A good way to ensure your PR is against the current master repo when | ||
submitted, you can do the following: | ||
|
||
Add the following alias to your .gitconfig file: | ||
|
||
``` | ||
[alias] | ||
pu = !"git fetch origin -v; git fetch upstream -v; git merge | ||
upstream/master" | ||
``` | ||
|
||
Then run the following command to set upstream: | ||
|
||
`git remote add upstream [email protected]:TheRealBill/redskull.git` if using | ||
SSH, or `git remote add upstream | ||
https://github.com/therealbill/redskull.git` if using HTTPS to | ||
login. | ||
|
||
Now, for the sync step you simply run `git pu` from within the repo | ||
and upstream changes will be pulled and merged - provided there are no | ||
conflicts. | ||
|
||
## Making Your Changes | ||
|
||
Before making *any* changes create a dedicated branch with a good | ||
succinct name. If it fixes an issue in Github, call it something like | ||
'bugfix-ghNNN" where NNN is the issue number. If it fixes something | ||
not in the issue list, create the issue first thus reducing to the | ||
previously known solution. | ||
|
||
For new features, see above but a scheme such as 'feature-ghNNN' would | ||
be ideal. | ||
|
||
This way it will help prioritize merges. | ||
|
||
If you're makign documentation improvements, first woohoo!. Next see | ||
above but perhaps something like 'docs-ghNNN'? | ||
|
||
Why this scheme? Because GitHub's issues interface is a bit dodgy and | ||
I think this might help with some automatic filtering - and should | ||
help me when I look at your PR to put me in the right context as I dig | ||
into it. | ||
|
||
And just in case it wasn't clear above - one issue per PR, please. I'd | ||
rather have a quick review of 5 PRs than one big one. | ||
|
||
|
||
## Validating Code | ||
|
||
In addition to unit testing where it makes sense, you will need to run | ||
some go checks prior to submitting code. This is a good way to do | ||
them: | ||
|
||
```shell | ||
go fmt | ||
go vet | ||
go build | ||
``` | ||
Once it builds, run it and test the functions touched by your changes. | ||
If it breaks, fix it. | ||
|
||
This is considered the minimum you should be doing to ensure your code | ||
doesn't break upstream. | ||
|
||
## Submitting the Pull Request | ||
|
||
First things first, squash your commits. If you're like me you | ||
probably commit early and commit often. This is great as you go along, | ||
but not so great for me as I sift through them. So, please squash your | ||
commits. Don't know what that means? Yeah neither did I until someone | ||
made this request for one of my PRs somewhere. | ||
|
||
To learn how, I recommend this page: http://bit.ly/10FV2x7 | ||
|
||
Frankly if the PR only has a few (i.e under 6-ish) I'll probably let it | ||
be. Unless Red Skull gets flooded with PRs in which case I'll likely | ||
have to be a bit more ... adamant about it. | ||
|
||
Detail your changes, reference any Github issues related and any | ||
enhancement proposals, and explain what your PR is all about. No | ||
matter how trivial your change is. Pull Requests without details will | ||
be summarily closed, occasionally with a comment indicating why. | ||
|
||
After you make issue the PR do not make changes in that branch. Many | ||
people coming from the Subversion world don't realize additional | ||
changes are automatically added to the pull request. Yeah, that bit me | ||
too. So don't do it. Besides, if you're requesting that dedicated | ||
branch be merged aren't you done with it anyway? | ||
|
||
Of course, if changes have to be made to address issues or for | ||
improvements during the PR review process by all means make them. | ||
|
||
# Licensing of Pull Request Code | ||
|
||
I find this to be a thorny and tricky subject, but IMO it is best to | ||
address it early. Basic rule here is for non-trivial code to submit it | ||
under the Apache v2 license, public domain, or assign me copyright. | ||
Why? To prevent problems laer down the road. If it is a big chunk of | ||
code please try to note in the PR your options here. I'm not going to | ||
be a stickler about it u tit would help prevent issues down the road. | ||
|
||
If you don't specify it will be assumed you are submitting it under | ||
the Apache license as noted above. I expect this to be enough, really. | ||
But lately some fairly hgh profile projects have been hit by this. | ||
|
||
|
||
# Summary | ||
|
||
If you are a seasoned contrinutor to other projects on Github much of | ||
this will be familiar to you and kudos for reading this far anyway! If | ||
not, well now you've been given a quick lesson in how to get your | ||
contributions' acceptance chance improved for many projects. | ||
|
||
|
||
|
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 |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# sshd on archlinux | ||
# | ||
# VERSION 0.0.1 | ||
|
||
FROM base/archlinux:latest | ||
MAINTAINER Bill Anderson <[email protected]> | ||
|
||
# Update the repositories | ||
RUN pacman -Syy | ||
|
||
# Install redis | ||
RUN pacman -S --noconfirm redis supervisor | ||
|
||
# Expose tcp ports | ||
EXPOSE 26379 | ||
EXPOSE 8000 | ||
|
||
ADD docker/sentinel.conf /etc/redis/sentinel.conf | ||
ADD docker/supervisord.conf /etc/supervisord.conf | ||
ADD docker/supervisord /etc/supervisor.d/ | ||
ADD docker/consul.d /etc/consul.d/ | ||
ADD html/ /usr/redskull/html/ | ||
ADD redskull /usr/redskull/ | ||
ADD https://dl.bintray.com/mitchellh/consul/0.4.1_linux_amd64.zip /tmp/consul.zip | ||
RUN cd /bin && zcat /tmp/consul.zip >consul && chmod +x /bin/consul && rm /tmp/consul.zip | ||
|
||
# Run daemon | ||
CMD ["/usr/bin/supervisord"] |
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 |
---|---|---|
@@ -0,0 +1,6 @@ | ||
github.com/kelseyhightower/envconfig | ||
github.com/therealbill/airbrake-go | ||
github.com/therealbill/libredis/client | ||
github.com/therealbill/libredis/info | ||
github.com/zenazn/goji | ||
github.com/dustin/go-humanize |
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 |
---|---|---|
@@ -0,0 +1,202 @@ | ||
Apache License | ||
Version 2.0, January 2004 | ||
http://www.apache.org/licenses/ | ||
|
||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
||
1. Definitions. | ||
|
||
"License" shall mean the terms and conditions for use, reproduction, | ||
and distribution as defined by Sections 1 through 9 of this document. | ||
|
||
"Licensor" shall mean the copyright owner or entity authorized by | ||
the copyright owner that is granting the License. | ||
|
||
"Legal Entity" shall mean the union of the acting entity and all | ||
other entities that control, are controlled by, or are under common | ||
control with that entity. For the purposes of this definition, | ||
"control" means (i) the power, direct or indirect, to cause the | ||
direction or management of such entity, whether by contract or | ||
otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
||
"You" (or "Your") shall mean an individual or Legal Entity | ||
exercising permissions granted by this License. | ||
|
||
"Source" form shall mean the preferred form for making modifications, | ||
including but not limited to software source code, documentation | ||
source, and configuration files. | ||
|
||
"Object" form shall mean any form resulting from mechanical | ||
transformation or translation of a Source form, including but | ||
not limited to compiled object code, generated documentation, | ||
and conversions to other media types. | ||
|
||
"Work" shall mean the work of authorship, whether in Source or | ||
Object form, made available under the License, as indicated by a | ||
copyright notice that is included in or attached to the work | ||
(an example is provided in the Appendix below). | ||
|
||
"Derivative Works" shall mean any work, whether in Source or Object | ||
form, that is based on (or derived from) the Work and for which the | ||
editorial revisions, annotations, elaborations, or other modifications | ||
represent, as a whole, an original work of authorship. For the purposes | ||
of this License, Derivative Works shall not include works that remain | ||
separable from, or merely link (or bind by name) to the interfaces of, | ||
the Work and Derivative Works thereof. | ||
|
||
"Contribution" shall mean any work of authorship, including | ||
the original version of the Work and any modifications or additions | ||
to that Work or Derivative Works thereof, that is intentionally | ||
submitted to Licensor for inclusion in the Work by the copyright owner | ||
or by an individual or Legal Entity authorized to submit on behalf of | ||
the copyright owner. For the purposes of this definition, "submitted" | ||
means any form of electronic, verbal, or written communication sent | ||
to the Licensor or its representatives, including but not limited to | ||
communication on electronic mailing lists, source code control systems, | ||
and issue tracking systems that are managed by, or on behalf of, the | ||
Licensor for the purpose of discussing and improving the Work, but | ||
excluding communication that is conspicuously marked or otherwise | ||
designated in writing by the copyright owner as "Not a Contribution." | ||
|
||
"Contributor" shall mean Licensor and any individual or Legal Entity | ||
on behalf of whom a Contribution has been received by Licensor and | ||
subsequently incorporated within the Work. | ||
|
||
2. Grant of Copyright License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
copyright license to reproduce, prepare Derivative Works of, | ||
publicly display, publicly perform, sublicense, and distribute the | ||
Work and such Derivative Works in Source or Object form. | ||
|
||
3. Grant of Patent License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
(except as stated in this section) patent license to make, have made, | ||
use, offer to sell, sell, import, and otherwise transfer the Work, | ||
where such license applies only to those patent claims licensable | ||
by such Contributor that are necessarily infringed by their | ||
Contribution(s) alone or by combination of their Contribution(s) | ||
with the Work to which such Contribution(s) was submitted. If You | ||
institute patent litigation against any entity (including a | ||
cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
or a Contribution incorporated within the Work constitutes direct | ||
or contributory patent infringement, then any patent licenses | ||
granted to You under this License for that Work shall terminate | ||
as of the date such litigation is filed. | ||
|
||
4. Redistribution. You may reproduce and distribute copies of the | ||
Work or Derivative Works thereof in any medium, with or without | ||
modifications, and in Source or Object form, provided that You | ||
meet the following conditions: | ||
|
||
(a) You must give any other recipients of the Work or | ||
Derivative Works a copy of this License; and | ||
|
||
(b) You must cause any modified files to carry prominent notices | ||
stating that You changed the files; and | ||
|
||
(c) You must retain, in the Source form of any Derivative Works | ||
that You distribute, all copyright, patent, trademark, and | ||
attribution notices from the Source form of the Work, | ||
excluding those notices that do not pertain to any part of | ||
the Derivative Works; and | ||
|
||
(d) If the Work includes a "NOTICE" text file as part of its | ||
distribution, then any Derivative Works that You distribute must | ||
include a readable copy of the attribution notices contained | ||
within such NOTICE file, excluding those notices that do not | ||
pertain to any part of the Derivative Works, in at least one | ||
of the following places: within a NOTICE text file distributed | ||
as part of the Derivative Works; within the Source form or | ||
documentation, if provided along with the Derivative Works; or, | ||
within a display generated by the Derivative Works, if and | ||
wherever such third-party notices normally appear. The contents | ||
of the NOTICE file are for informational purposes only and | ||
do not modify the License. You may add Your own attribution | ||
notices within Derivative Works that You distribute, alongside | ||
or as an addendum to the NOTICE text from the Work, provided | ||
that such additional attribution notices cannot be construed | ||
as modifying the License. | ||
|
||
You may add Your own copyright statement to Your modifications and | ||
may provide additional or different license terms and conditions | ||
for use, reproduction, or distribution of Your modifications, or | ||
for any such Derivative Works as a whole, provided Your use, | ||
reproduction, and distribution of the Work otherwise complies with | ||
the conditions stated in this License. | ||
|
||
5. Submission of Contributions. Unless You explicitly state otherwise, | ||
any Contribution intentionally submitted for inclusion in the Work | ||
by You to the Licensor shall be under the terms and conditions of | ||
this License, without any additional terms or conditions. | ||
Notwithstanding the above, nothing herein shall supersede or modify | ||
the terms of any separate license agreement you may have executed | ||
with Licensor regarding such Contributions. | ||
|
||
6. Trademarks. This License does not grant permission to use the trade | ||
names, trademarks, service marks, or product names of the Licensor, | ||
except as required for reasonable and customary use in describing the | ||
origin of the Work and reproducing the content of the NOTICE file. | ||
|
||
7. Disclaimer of Warranty. Unless required by applicable law or | ||
agreed to in writing, Licensor provides the Work (and each | ||
Contributor provides its Contributions) on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
implied, including, without limitation, any warranties or conditions | ||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
PARTICULAR PURPOSE. You are solely responsible for determining the | ||
appropriateness of using or redistributing the Work and assume any | ||
risks associated with Your exercise of permissions under this License. | ||
|
||
8. Limitation of Liability. In no event and under no legal theory, | ||
whether in tort (including negligence), contract, or otherwise, | ||
unless required by applicable law (such as deliberate and grossly | ||
negligent acts) or agreed to in writing, shall any Contributor be | ||
liable to You for damages, including any direct, indirect, special, | ||
incidental, or consequential damages of any character arising as a | ||
result of this License or out of the use or inability to use the | ||
Work (including but not limited to damages for loss of goodwill, | ||
work stoppage, computer failure or malfunction, or any and all | ||
other commercial damages or losses), even if such Contributor | ||
has been advised of the possibility of such damages. | ||
|
||
9. Accepting Warranty or Additional Liability. While redistributing | ||
the Work or Derivative Works thereof, You may choose to offer, | ||
and charge a fee for, acceptance of support, warranty, indemnity, | ||
or other liability obligations and/or rights consistent with this | ||
License. However, in accepting such obligations, You may act only | ||
on Your own behalf and on Your sole responsibility, not on behalf | ||
of any other Contributor, and only if You agree to indemnify, | ||
defend, and hold each Contributor harmless for any liability | ||
incurred by, or claims asserted against, such Contributor by reason | ||
of your accepting any such warranty or additional liability. | ||
|
||
END OF TERMS AND CONDITIONS | ||
|
||
APPENDIX: How to apply the Apache License to your work. | ||
|
||
To apply the Apache License to your work, attach the following | ||
boilerplate notice, with the fields enclosed by brackets "{}" | ||
replaced with your own identifying information. (Don't include | ||
the brackets!) The text should be enclosed in the appropriate | ||
comment syntax for the file format. We also recommend that a | ||
file or class name and description of purpose be included on the | ||
same "printed page" as the copyright notice for easier | ||
identification within third-party archives. | ||
|
||
Copyright {yyyy} {name of copyright owner} | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
|
Oops, something went wrong.