Skip to content
Switch branches/tags
Go to file
Cannot retrieve contributors at this time
39 lines (30 sloc) 2.09 KB

Contributing to rest-hapi

Hey there! We’re really excited that you are interested in contributing to rest-hapi. Before submitting your contribution though, please make sure to take a moment and read through the following guidelines.

Code of Conduct

Please note that this project has a Code of Conduct. It's important that you review and enforce it.

Code contributions

Here is a quick guide to doing code contributions to the library.

  1. Find some issue you're interested in, or a feature that you'd like to tackle. Also make sure that no one else is already working on it. If it's a feature you're requesting, make sure it's aligned with the direction of the project by creating an issue and discussing it with the core maintainers. We don't want you to be disappointed.
  2. Fork the repo
  3. Create a branch off of the master branch. Prefix your branch with either "feature/", "bugfix/", or something similar describing the type of update, and then add a descriptive name such as "bugfix/random_files_erased".
  4. Add your changes.
  • Please try to avoid monolithic commits.
  • Code must follow the Javascript Standard Style.
  • Your code must pass eslint filters to be able to commit.
  1. Make sure your master branch is in sync/up-to-date with the original.
  2. Before submitting a pull request, merge in your synced master branch with your current branch and resolve any conflicts.
  3. Once all conflicts are resolved, submit a pull request to the origin master branch.
  4. Your pull request will be reviewed along with change requests or comments.
  5. After all requests are complete, your pull request will be merged in.
  6. Celebrate! πŸŽ‰

NOTE: Don't forget to update the docs! πŸ˜‰

This is my first Pull Request, where can I learn how to contribute?

You can take this free course: How to Contribute to an Open Source Project on GitHub.