Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (37 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

52 lines (37 loc) · 1.45 KB

Contributing to the Project

We welcome contributions from the community! This document provides guidelines for contributing to the project.

How to Contribute

  1. Fork the Repository
  • Fork the project to your GitHub account
  • Clone your forked repository locally
  1. Create a Branch
  • Create a new branch for your feature or bugfix
  • Use a clear and descriptive branch name
  • Example: feat/add-new-functionality or fix/resolve-issue-123
  1. Make Changes
  • Make your changes in the new branch
  • Follow the project's coding style and conventions
  • Write clear, concise commit messages
  1. Testing
  • Ensure all existing tests pass
  • Add new tests for your changes if applicable
  • Run the test suite before submitting a pull request
  1. Submit a Pull Request
  • Push your changes to your fork
  • Open a pull request against the main repository
  • Provide a clear description of your changes
  • Reference any related issues

Code of Conduct

  • Be respectful and inclusive
  • Listen to feedback constructively
  • Collaborate and help each other

Reporting Issues

  • Use the GitHub Issues section
  • Provide a clear and detailed description
  • Include steps to reproduce the issue
  • Specify your environment (OS, version, etc.)

Questions?

If you have any questions, please open an issue or reach out to the maintainers.

Thank you for contributing!