Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

51 lines (32 loc) · 2.14 KB

Contributing

First of all, thank you for considering contributing! It's people like you that make the open-source community such a great place.

Code of Conduct

This project and everyone participating in it are governed by the Code of Conduct. By participating, you agree to uphold this code.

How Can I Contribute?

Reporting Bugs

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:

  • Use a clear and descriptive title for the issue.
  • Describe the exact steps which reproduce the problem in as much detail as possible.
  • Provide specific examples to demonstrate the steps. Include snippets of the code you have used.
  • Include screenshots and animated GIFs if possible.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for [Your Library Name], including new features and minor improvements to existing functionality.

  • Use a clear and descriptive title for the issue.
  • Provide a step-by-step description of the suggested enhancement.
  • Provide specific examples to demonstrate the steps. Include snippets of the TypeScript code that you envision as part of your suggestion.
  • Include screenshots and animated GIFs if possible.

Pull Requests

  • Fill in the required template.
  • Do not include issue numbers in the PR title.
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • Follow the TypeScript style guidelines.
  • End all files with a newline.

TypeScript Styleguide

  • All TypeScript must adhere to TypeScript Standard Style.
  • Use types and interfaces appropriately.
  • Avoid using any type unless absolutely necessary.

This section lists the labels we use to help us track and manage issues and pull requests.

Type of Issue and Issue State

  • bug: This issue is a bug.
  • enhancement: This issue is an enhancement.

Acknowledgments