Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (42 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

64 lines (42 loc) · 1.63 KB

Contributing

Thank you for considering contributing to this project. This document provides guidelines for contributing effectively.

Types of Contributions

We welcome all types of contributions:

  • Bug fixes and feature implementations
  • Documentation improvements
  • Code refactoring and test coverage
  • Bug reports and feature requests
  • Pull request reviews

Guidelines

Requirements

  • Pull requests should target the main branch
  • Use the .editorconfig file to maintain consistent coding styles (EditorConfig)
  • Follow Conventional Commits specification for commit messages
  • Ensure all tests pass before submitting

Commit Message Format

<type>(<scope>): <subject>

Types: feat, fix, docs, style, refactor, test, chore

Example: feat(auth): add OAuth2 authentication support

Contribution Process

  1. Fork the repository and create a topic branch from main
  2. Make your changes following the project's code style
  3. Test your changes thoroughly
  4. Commit using conventional commit messages
  5. Push to your fork and submit a pull request
  6. Respond to review feedback

Questions

Before asking a question:

  • Search existing Issues
  • Review project documentation

If you need assistance, open a new Issue with:

  • Clear description of the problem
  • Relevant environment details
  • Steps to reproduce (if applicable)

Code of Conduct

All contributors must adhere to the project's Code of Conduct.

❤️ Thank you for contributing to this project.