Skip to content

Latest commit

 

History

History
75 lines (52 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

75 lines (52 loc) · 2.27 KB

Contributing Guidelines

Thank you for your interest in contributing! This document provides guidelines and steps for contributing to this project.

Code of Conduct

By participating in this project, you agree to maintain a respectful and inclusive environment for everyone. Please:

  • Use welcoming and inclusive language
  • Be respectful of differing viewpoints and experiences
  • Accept constructive criticism gracefully
  • Focus on what is best for the community

How to Contribute

Reporting Issues

  • Before creating an issue, please check if a similar issue already exists
  • Provide a clear and descriptive title
  • Include detailed steps to reproduce the issue
  • Specify your environment/version information
  • Include any relevant code snippets or error messages

Pull Requests

  1. Fork the repository
  2. Create a new branch for your feature (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Commit your changes (git commit -m 'Add some amazing feature')
  5. Push to the branch (git push origin feature/amazing-feature)
  6. Open a Pull Request

Pull Request Guidelines

  • Keep your changes focused and atomic
  • Update documentation as needed
  • Add tests if applicable
  • Follow the existing code style
  • Verify all tests pass
  • Include a clear description of the changes
  • Link any related issues using keywords (Fixes #123, Closes #456)

Style Guidelines

  • Follow the existing code style and conventions
  • Use clear, descriptive variable and function names
  • Add comments for complex logic
  • Keep functions focused and modular
  • Remove any debugging code or console logs
  • Ensure proper error handling

Development Setup

  1. Fork and clone the repository
  2. Install any required dependencies
  3. Follow the README.md setup instructions
  4. Make your changes in a new git branch

Documentation

  • Update README.md if you change functionality
  • Comment your code where necessary
  • Update any relevant documentation

Questions or Need Help?

Feel free to reach out to me on LinkedIn if you have any questions or need clarification.

License

By contributing, you agree that your contributions will be licensed under the same license as the original project.

Thank you for contributing to make this project better!