Project

feedhub

0.0
No commit activity in last 3 years
No release in over 3 years
Save data (from a form or from s.t. else) as github issue
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

 Project Readme

Description: Use all of the github issue benefits by saving data as github issue.

##Use case:##

For example, if your website provides a feedback form: Instead of saving it into an extra feedback model, you can autmatically open a new issue in a github repo with the users text and the according label.

Benefits:

  • No model, no interface to implement
  • Comments (team can discuss feedback)
  • Assignments
  • Labels (filtering)
  • See issues state (open / closed)

##How to use##

Setup:

# The github account to login. This github account will
# create the issues
Feedhub::set_user(:name => 'github-account', :password => 'user-password')

# The github repository to save the issue
# (I.e. here: webarbeit, feedhub)
Feedhub::set_repo(:account => 'repo-account', :name => 'repo-name')

Open issue:

# params subject, body, label
Feedhub::open_issue(:title => 'The title', :body => 'Here I write a bit more', :label => "question")

Throws error if labels does not exist.

The open_issue! Method with bang! creates a new label, if it does not already exist.

# params subject, body, label
Feedhub::open_issue!(:title => 'The title', :body => 'Here I write my feedback', :label => "newlabel")

##Dependencies:##

  • octokit