Skip to content

Latest commit

 

History

History
35 lines (21 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

35 lines (21 loc) · 1.62 KB

Contributing Guidelines

Thanks you so much for your interest in contributing to this project!

About our deal

Hi! I'm Alexandre and i'm the creator and maintainer of this project.

If you encounter bugs, please do open an issue describing the bug and including steps to easily reproduce it (bonus points for a CodeSandbox that demonstrates the problem).

If you have an idea for an enhancement, go ahead and share it via an issue, but please don't expect a timely response.

This project is MIT-licensed, and this means that you can implement and use whatever enhancements you'd like.

Commits and Code Standardization

This project follow the Conventional Commits specification. Husky execute scrips according to git hooks in order to test if a developer is following the Eslint Lint Rules and also the commits convention.

Bug reports

If you encounter a problem with this project, please open an issue. Be sure to include:

  • Package version
  • Node and Express versions
  • Brief but thorough description of the issue
  • Link to a CodeSandbox (or similar) demonstrating the problem (optional, but highly recommended, especially for complex problems)

How to Contribute

  1. Fork this repository;
  2. Create your feature branch: git checkout -b feature/feature-name;
  3. Commit your changes: git commit -m 'feat: add some feature';
  4. Push to the branch: git push origin feature/feature-name.

After your pull request is merged, you can safely delete your branch