Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
vromero committed Jul 4, 2017
0 parents commit 036ecbd
Show file tree
Hide file tree
Showing 32 changed files with 1,812 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
dist/
vendor
coverage.txt
.idea/
gofortune
4 changes: 4 additions & 0 deletions .goreleaser-hooks.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/bin/sh

for DIR in $(find dist -name gofortune -exec dirname \{\} \; | grep -v Windows); do cd $DIR && ln -s gofortune fortune; ln -s gofortune strfile; cd -; done

19 changes: 19 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@

language: go

go: 1.8.3

install:
- make setup
- gem install fpm

script:
- make all

after_success:
- bash <(curl -s https://codecov.io/bash)
- test -n "$TRAVIS_TAG" && curl -sL https://git.io/goreleaser | bash

notifications:
email: false

74 changes: 74 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
123 changes: 123 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
# Contributing to GoFortune

Thank you for contributing! GoFortune welcomes contributions following the guidelines described in this document.

This document outlines the procedures and what to expect when contributing documentation, a bug report,
a feature request, or new code via a pull request. I

Please read and follow these guidelines before submitting a bug report, feature request or pull request.

- [Code of Conduct](#code-of-conduct)
- [Question or Problem?](#got-a-question-or-problem)
- [Issues and Bugs](#issues-and-bugs)
- [Feature Requests](#feature-requests)
- [Submission Guidelines](#submission-guidelines)
- [Coding Rules](#coding-rules)
- [Signing the CLA](#signing-the-cla)

## Code of Conduct

Make sure you help to keep GoFortune open and inclusive. Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).

## Got a Question or Problem?

If you have questions or a problem related with GoFortune, please direct these to the issue tracker.
Although it seems clear an issue tracker is not the best communication mechanism, for the time
being there is no need for any other mechanism.

## Found an Issue?

If you find a bug in the source code or a mistake in the documentation, you can help by
submitting an issue to our [GitHub Repository](http://www.github.com/vromero/gofortune).
Even better you can submit a Pull Request with a fix.

**Please see the [Submission Guidelines](#submission-guidelines) below.**

## Want a Feature?

You can request a new feature by submitting an issue to our [GitHub Repository](http://www.github.com/vromero/gofortune). If you
would like to implement a new feature then consider a Pull Request.

**Please see the [Submission Guidelines](#submission-guidelines) below.**

## <a name="submit"></a> Submission Guidelines

### Submitting an Issue
Before you submit your issue search the archive, maybe your question was already answered.

If your issue appears to be a bug, and hasn't been reported, open a new issue.

### Submitting a Pull Request

Before you submit your pull request consider the following guidelines:

* Search GitHub for an open or closed Pull Request
that relates to your submission. You don't want to duplicate effort.
* Please sign our Contributor License Agreement (CLA) before sending pull
requests. Code cannot be accepted without this.
* Make your changes in a new git branch:

```shell
git checkout -b feature/my-new-feature master
```

* Create your patch, **including appropriate test cases**.
* Follow our [Coding Rules](#coding-rules).
* Run the full test suite and ensure that all tests pass.
* Commit your changes using a descriptive commit message.
* Push your branch to GitHub:

In GitHub, send a pull request to `vromero/gofortune:master`.

If the PR gets too outdated it may be asked to rebase and force push to update the PR:

```shell
git rebase master -i
git push origin feature/my-new-feature -f
```

That's it! Thank you for your contribution!
#### After your pull request is merged
After your pull request is merged, you can safely delete your branch and pull the changes
from the main (upstream) repository:
* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
```shell
git push origin --delete feature/my-new-feature
```
* Check out the master branch:
```shell
git checkout master -f
```
* Delete the local branch:
```shell
git branch -D feature/my-new-feature
```
* Update your master with the latest upstream version:
```shell
git pull --ff upstream master
```
## Coding Rules
To ensure consistency throughout the source code, keep these rules in mind as you are working:
* All features or bug fixes **must be tested** by one or more tests.
* All public API methods **must be documented**.
* With the exceptions listed below, we follow the rules contained in
[Google's Go Style Guide][https://github.com/golang/go/wiki/CodeReviewComments]:

## Signing the CLA

Please sign our Contributor License Agreement (CLA) before sending pull requests. For any code
changes to be accepted, the CLA must be signed. It's a quick process, we promise!
Loading

0 comments on commit 036ecbd

Please sign in to comment.