Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

64 lines (40 loc) · 2.59 KB

Contributing to Vnpay

First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to this project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of Conduct

This project and everyone participating in it is governed by the Vnpay Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to lehuygiang28@gmail.com.

How Can I Contribute?

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.

  • 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.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for this project, including completely new features and minor improvements to existing functionality.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as 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.
  • End all files with a newline
  • Preferably, add tests or examples when introducing new features or fixing bugs.

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

TypeScript Styleguide

All TypeScript must adhere to the TypeScript Style Guide.

Setting Up Your Development Environment

  1. Fork and clone the repository
  2. Run npm install to install local dependencies
  3. Code your feature or bug fix
  4. Run npm test to run the test suite
  5. If everything passes, send a pull request

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 or PRs related to bugs.
  • feature - Issues or PRs related to feature requests.
  • duplicate - Issues or PRs that are duplicates of other issues or PRs.
  • wontfix - Issues or PRs that we do not plan to work on.