README.md

Documentation

Table of Contents

• Documentation
  • Api Reference
  • Usage
  • Contributing

Api Reference

All functions are exported from the main module. You can import them like this:

const { functionName } = require('developer-toolkit-utils');

If you would like to View every function in this library, check out the API Reference Folder.

Usage

Check our examples file for examples on how to use the functions in this library.

Contributing

Reporting Bugs

This section guides you through submitting a bug report for this project. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.

---

Before Submitting A Bug Report

• Check the FAQs for a list of common questions and problems.

• Search for Similar Issues

---

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. After you've determined which repository your bug is related to, create an issue on that repository and provide the following information by filling in the template.

• Use a clear and descriptive title for the issue to identify the problem.

• Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you started the project, e.g. which command exactly you used in the terminal. When listing steps, don't just say what you did, but explain how you did it. For example, if you moved the cursor to the end of a line, explain if you used the mouse, or a keyboard shortcut or an IDE action.

• Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.

• Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.

• Explain which behavior you expected to see instead and why.

• Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem. You can use this tool to record GIFs on macOS and Windows, and [this tool](

---

Faqs

• How do I update my forked repository?

  • Syncing a fork
  • Syncing a fork to keep it up-to-date

• How do I create a pull request?

  • Creating a pull request

• How do I create a new branch?

  • Creating and deleting branches
  • Creating a new branch

• How do I add a remote?

  • Adding a remote (1)
  • Adding a remote (2)

• How do I push to a remote?

  • Pushing to a remote (1)
  • Pushing to a remote (2)