Skip to content
This repository has been archived by the owner on Jan 26, 2025. It is now read-only.

Latest commit

 

History

History
101 lines (75 loc) · 3.91 KB

CONTRIBUTING.md

File metadata and controls

101 lines (75 loc) · 3.91 KB

Contribution Guidelines

Thank you for considering contributing to this project! We welcome all types of contributions, from reporting bugs to suggesting enhancements and writing code. To ensure a smooth and efficient collaboration, please follow these guidelines.

Table of Contents

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please take a moment to review it.

How to Contribute

Reporting Bugs

If you find a bug, please create an issue using the bug report template. Provide as much information as possible to help us reproduce and fix the issue quickly.

Suggesting Enhancements

If you have an idea for a new feature or an improvement, please create an issue using the feature request template. Describe your idea in detail so we can discuss it.

Contributing Code

Development Workflow

  1. Fork the repository.
  2. Clone your fork. 
    git clone https://github.com/allanoricil/esp32-mfa-authenticator.git
  3. Create a new branch for your feature or bugfix. 
    git checkout -b feature-or-bugfix-name
  4. Make your changes.
  5. Commit your changes following our Commit Messages guidelines.
  6. Push your branch to your fork. 
    git push origin feature-or-bugfix-name
  7. Open a pull request against the main branch of the original repository.

Coding Standards

  • Follow the existing code style.
  • Write clear, concise, and well-documented code.
  • Include unit tests for any new functionality or changes.
  • Ensure all tests pass before submitting your pull request.

Commit Messages

This project uses Conventional Commits. Please, format your commit message as follows:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing or correcting existing tests
  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • chore: Other changes that don't modify src or test files
  • revert: Reverts a previous commit

Example

feat: add user authentication

- Added JWT-based authentication
- Updated user model with authentication methods
- Created login and registration endpoints

Pull Request Process

  1. Ensure your code follows the Coding Standards.
  2. Verify all tests pass and add new tests if applicable.
  3. Describe the purpose of the pull request in the description.
  4. Reference any related issues.
  5. One of the maintainers will review your pull request. Please be responsive to any feedback.

License

By contributing, you agree that your contributions will be licensed under the project's MIT License.

Thank you for your contributions! We look forward to collaborating with you.