Skip to content
This repository has been archived by the owner on Feb 8, 2019. It is now read-only.

Latest commit

 

History

History
55 lines (40 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

55 lines (40 loc) · 2.05 KB
Raw

Contributing to HarperDB NodeJS Driver

Thank you for considering to contribute to the harperdb-nodejs-driver project!

Table Of Contents

Getting Started

  1. Fork this repository
  2. Clone your fork to you local machine using git clone [fork]
  3. Go through the project set up process in the README.md

Back To Top

Writing your First PR

  1. Make sure to maintain your local fork
  2. Create a branch on your local repo using git checkout -b [branch-name]
  3. Write your code 💻🔥
  4. Run git status to see all the files you have edited
  5. Add the files using git add .
  6. Run git commit -m '[Commit Message]'
  7. And finally: git push -u origin master
  8. Navigate to your choice of browser and go to your fork repository
  9. There should be a prompt to open a new PR, click that.
  10. Follow the embedded contributing guidelines.

Back To Top

Maintaining your Fork

  1. Make sure to checkout the master branch git checkout master
  2. Add this repository to the remote using git remote add upstream https://github.com/Ethan-Arrowood/harperdb-nodejs-driver/
  3. Run git pull --rebase upstream master

Back To Top

Reporting A Bug

If you have found a bug in the project please open a new issue and add [Bug] to the title. This will help contributors spot it quickly and figure out a solution.

Back To Top

Requesting an Enhancement

When requesting a new feature make sure to add [Enhancement] to your issue title.

For example: [Enhancement] Add onError() Handler Method

Back To Top

Get Help

Need help contributing? Feel free to mention it in an issue comment (refrain from opening a help issue). You can also reach out to Ethan Arrowood on twitter.

Back To Top