Skip to content

Commit

Permalink
Merge pull request #1041 from scott/release/2.2.0
Browse files Browse the repository at this point in the history
Release/2.2.0
  • Loading branch information
scott committed Dec 4, 2018
2 parents 621ddad + 460d495 commit 592bc60
Show file tree
Hide file tree
Showing 5 changed files with 87 additions and 2 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ public/uploads
/.ruby-version
/.ruby-gemset
/.rvmrc
.vscode

# Docker stuff
.env
Expand Down
64 changes: 64 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# How to contribute to Helpy

Welcome, and thanks for contributing to Helpy. Together we are building
the best customer support platform in the world. Here are some of the ways
you can contribute:

**If you find a security bug, do not report it through GitHub. Please send an
e-mail to [hello@helpy.io](mailto:hello@helpy.io)
instead. See [SECURITY.md](/SECURITY.md) for more.a**

- Report or fix Bugs- Before reporting a new issue, please be sure that the issue wasn't already
reported or fixed by searching on GitHub through our [issues](https://github.com/helpyio/helpy/issues).

When creating a new issue, be sure to include a **title and clear description**,
as much relevant information as possible, and either detailed steps to recreate the
issue or a test case example - Helpy has a lot
of moving parts and it's functionality can be affected by third party gems, so
we need as much context and details as possible to identify what might be broken
for you.

- Refactoring- There are many opportunities to refactor code within Helpy to
make it more concise, faster, more readable, remove duplication, etc.

- Improve test coverage- As with any large and growing codebase, test coverage
is not always as good as it could be. Help improving test coverage is always
welcome and will help you learn how Helpy works. We use Minitest exclusively.

- Translate the project- The community has already translated Helpy into 20+
languages, but there are many more waiting. We need help getting Helpy
translated into as many locales as possible! Please see the guide to
translation for more details.

- Build new features. There is a backlog of new features that the community would
like to see built. Check out our roadmap for more insight on this, and if you would like
to take one on, please get in touch with us to make sure someone is not already
working on it.

Before sending a new Pull Request, take a look on existing Pull Requests and Issues
to see if the proposed change or fix has been discussed in the past, or if the
change was already implemented but not yet released.

We expect new Pull Requests to include enough tests for new or changed behavior,
and we aim to maintain everything as most backwards compatible as possible,
reserving breaking changes to be shipped in major releases when necessary.

If your Pull Request includes new or changed behavior, be sure that the changes
are beneficial to a wide range of use cases or it's an application specific change
that might not be so valuable to other applications. Some changes can be introduced
as a new `Helpy-something` gem instead of belonging to the main codebase.

#General Guidelines:

- Join us on Slack. Let me know you wish to contribute.
- Make your PRs granular. They should only include one piece of functionality per PR.
- Check the roadmap. If you want to build a feature, contact us to make sure
no one else is already working on it
- You must provide passing test coverage. We use minitest, see
http://www.rubypigeon.com/posts/minitest-cheat-sheet/?utm_source=rubyweekly&utm_medium=email
- You also must expose functionality to the API. We use Grape. API methods should be
tested as well.
- If your feature/bug fix/enhancement adds or changes text in the project, please create
i18n strings in en.yml and any other locales you can.
- We are hugely concerned with user experience, and a nice UI. Oftentimes that means
we may take what you have contributed and “dress it up” or ask you to do the same.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Helpy: A Modern Helpdesk Platform for the Web
====================================

Helpy is a modern omnichannel helpdesk platform written in Ruby on Rails 4.2 and released under the MIT license. The goal of Helpy is to power your support email and ticketing, integrate seamlessly with your app, and run an amazing customer helpcenter.
Helpy is a modern multichannel helpdesk platform written in Ruby on Rails 4.2 and released under the MIT license. The goal of Helpy is to power your support email and ticketing, integrate seamlessly with your app, and run an amazing customer helpcenter.

[![Build Status](https://img.shields.io/travis/helpyio/helpy/master.svg)](https://travis-ci.org/helpyio/helpy) [![Code Climate](https://codeclimate.com/github/helpyio/helpy/badges/gpa.svg)](https://codeclimate.com/github/helpyio/helpy)

Expand Down Expand Up @@ -157,6 +157,11 @@ Welcome, and thanks for contributing to Helpy. Together we are building the bes
- If your feature/bug fix/enhancement adds or changes text in the project, please create i18n strings in `en.yml` and any other locales you can.
- We are hugely concerned with user experience, and a nice UI. Oftentimes that means we may take what you have contributed and “dress it up” or ask you to do the same.

Security Issues
===============

If you have found a vulnerability or other security problem in Helpy, please *do not open an issue* on GitHub. Instead, contact [hello@helpy.io](mailto: hello@helpy.io) directly by email. See the [SECURITY](/SECURITY.md) guide to learn more and see a hall of fame of security reporters.

License
=======

Expand Down
15 changes: 15 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Reporting security vulnerabilities and exploits

If you discover a security issue in Helpy, please *do not open an issue*. Instead, you should
either email [hello@helpy.io](mailto: hello@helpy.io) or join us in Slack and contact me (Scott Miller)
directly.

Please provide detailed information in your email with instructions (screenshots also helpful) of how to
reproduce the issue and any ideas on how best to mitigate will also be helpful!

# Security Hall of Fame

This section is reserved for individuals and organizations who have reported security issues. When
you report a verified security problem, you will have the option of being listed here for all to thank!

- Juan Bono (jbono)
2 changes: 1 addition & 1 deletion config/environment.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
Rails.application.initialize!

# Get the current tag version
VERSION = '2.1.0'
VERSION = '2.2.0'
REVISION = `git log --pretty=format:'%h' -n 1`
APP_VERSION = "#{VERSION}:#{REVISION}"

0 comments on commit 592bc60

Please sign in to comment.