Skip to content

Latest commit

 

History

History
70 lines (45 loc) · 3.3 KB

CONTRIBUTING.md

File metadata and controls

70 lines (45 loc) · 3.3 KB

Contributing to API Metering Library

First off, thank you for considering contributing to API Metering Library. It's people like you that make this library better for everyone.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report. 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 by filling out the required template.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.

Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible by filling out the required template.

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 styleguides
  • Include adequate tests for your changes
  • Document new code based on the documentation style guide
  • End all files with a newline

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

TypeScript Styleguide

  • Use 2 spaces for indentation
  • Prefer const over let. Never use var
  • Prefer template literals over string concatenation
  • Use semicolons
  • Use interface for defining types when possible

Documentation Styleguide

  • Use Markdown for documentation
  • Reference methods and classes in markdown with the custom @method and @class tags

Additional Notes

Issue and Pull Request Labels

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

  • bug - Issues that represent a bug in the library
  • documentation - Issues related to documentation
  • enhancement - Issues that request or represent an enhancement
  • good first issue - Good for newcomers
  • help wanted - Extra attention is needed
  • question - Further information is requested

Thank You!

Thank you for contributing to make API Metering Library better!