Skip to content

Latest commit

 

History

History
45 lines (37 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

45 lines (37 loc) · 2.32 KB
Raw

Contributing

Want to contribute to hain? Well, you've come to the right place!

First, join our mailing list and introduce yourself. You can join the mailing list by sending an email with Subscribe in the subject line to [email protected]

Ideas / Enhancements

If you have an idea for an enhancement, please join the mailing list to see how you can contribute that idea to hain, we can provide help with understanding the project and even help with learning a bit about programming.

Everyone is welcome to contribute in any way they would like.

Issues

When opening an issue, please go by the following:

  • Check if your issue has already been solved (search for the issue)
  • Check that you are running the latest version of hain (we recommend running the latest installer). Your issue may be fixed after updating.
  • Describe your problem in as much detail as possible
  • If the issue is about an error/bug, please make the error message the issue’s title (i.e. Error: Could not install package)
  • Don't open an issue about an issue with a package not shipped with hain
  • Include your system specs (OS, RAM, arch and version of hain installed) in the issue description

Pull requests

After forking and cloning your fork to a local machine, run the following:

$ cd <path-to-clone>
$ git remote add upstream https://github.com/hainproject/hain.git
$ git pull upstream develop
$ git checkout develop
$ git branch <your-feature-branch>
$ git checkout <your-feature-branch>
$ npm install
$ ...make your changes...
$ git push origin

When opening a pull request, please go by the following:

  • All pull requests should merge into the develop branch
  • Please check that you are not behind, by any number of commits, the branch you are merging into.
  • Describe your pull request in as much detail as possible (what's been fixed or what has been added + usage). Include an issue reference if the pull request fixes an issue.
  • If the pull request is to fix an error/bug, please include the error message in the issue's description if possible
  • Include your system specs (OS, etc) in the issue description
  • Check that the app can be built and ran successfully before submitting a pull request
  • Check that the ci passes successfully. Fix any bugs in your code if our ci (appveyor) fails with an error that may have somthing to do with your added code.