Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 2.53 KB
Raw

Contributing to Backup

Thank you for contributing to Backup!

Bugs

To report a bug, use the GitHub issue tracker. Please check the Open issues, and create a new issue if you do not see a report that matches the bug that you have found.

Backup is used with many different systems and configurations, so the first step for us to solve a problem is knowing how to reproduce it. You can help us solve your issue by including the versions of Ruby, Backup and the operating system on the computer that you used.

To submit a bug fix, please create a Pull Request. Always develop changes against the master branch. Read the Pull Requests section below for more help with preparing fixes.

New Features

We are happy to discuss requests for specific features. Please check the GitHub repository to see if the feature has already been requested, and create a new Issue if there is not already an issue that describes the feature that you need. A good feature request will clearly explain the feature that is required, and include a use case.

Of course, if you would like to write an implementation, that is even better! To submit a feature, please create a Pull Request. Always develop changes against the master branch. Read the Pull Requests section below for more help with developing features in this project.

Asking for (or Giving) Help

If you would like to talk about either using Backup or writing code for it, please leave a message in our Gitter room. Maintainers are not online at all times, but we will reply to any questions that you ask there.

Pull Requests

We use the standard GitHub Pull Requests feature. If you would like to discuss some details before you start working on a feature or bug fix, open an issue.

To help us review your code:

  • Use the latest version of the master branch as the base for your topic branch
  • Be sure to use the latest version of Ruby 2 when you write and test your code
  • In the comment box for your pull request, specify the operating system(s) and Ruby version that you have tested your code on
  • Write clear commit messages: the first line should be 50 characters or less, and be a clear summary of the commit, e.g. "Fix Nokogiri compile issue on macOS Sierra, GH #305".