Skip to content

Latest commit

 

History

History
65 lines (43 loc) · 3.28 KB

CONTRIBUTING.md

File metadata and controls

65 lines (43 loc) · 3.28 KB
Raw

Contributing

Where to start

There are many different ways to contribute to rest-api-node-typescript's development, just find the one that best fits with your skills. Examples of contributions we would love to receive include:

  • Code patches pull request
  • Documentation improvements
  • Translations(yet to come)
  • Bug reports
  • Patch reviews
  • UI enhancements

Submitting a Pull Requests

I welcome and encourage all pull requests. It usually will take me within 24-48 hours to respond to any issue or request. Here are some basic rules to follow to ensure the timely addition of your request:

  • Match the document style as closely as possible.
  • Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :)
  • Pull requests must be made against the development branch for this particular repository.
  • Check for existing issues first, before filing an issue.
  • Make sure you follow the set standard as all other projects in this repo
  • Have fun!

When contributing to this repository, please first discuss the change you wish to make via issue or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Reporting Issues

Have you identified a reproducible problem in this repo? Have a feature request? We want to hear about it! Here's how you can make reporting your issue as effective as possible.

##Look For an Existing Issue## Before you create a new issue, please do a search in open issues to see if the issue or feature request has already been filed.

Be sure to scan through the most popular feature requests.

If you find your issue already exists, make relevant comments and add your reaction. Use a reaction in place of a "+1" comment:

👍 - upvote

👎 - downvote

If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below.

##Writing Good Bug Reports and Feature Requests## File a single issue per problem and feature request. Do not enumerate multiple bugs or feature requests in the same issue.

Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar but have different causes.

The more information you can provide, the more likely someone will be successful in reproducing the issue and finding a fix.

Please include the following with each issue:

  • OS
  • The version of Node.js, npm / yarn
  • Reproducible steps (1... 2... 3...) that cause the issue
  • What you expected to see, versus what you actually saw
  • Images, animations, or a link to a video showing the issue occurring
  • A code snippet that demonstrates the issue or a link to a code repository the developers can easily pull down to recreate the issue locally
    • Note: Because the developers need to copy and paste the code snippet, including a code snippet as a media file (i.e. .gif) is not sufficient.
  • Errors from the Dev Tools Console (open from the menu: Help > Toggle Developer Tools)

##Thank You!## Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute.