Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (37 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

49 lines (37 loc) · 1.31 KB

Contributing to XL9535

Thank you for considering contributing to this project! Your help is greatly appreciated.

How to Contribute

1. Fork the Repository

Click the "Fork" button at the top right of this page to create your own copy of the repository.

2. Clone Your Fork

git clone https://github.com/your-username/XL9535.git
cd XL9535

3. Create a Branch

git checkout -b my-feature

4. Make Your Changes

  • Write clear, concise commit messages.
  • Add tests for new features or bug fixes.
  • Ensure all tests pass before submitting.
  • Run linting with flake8 or pylint before submitting.

5. Push to Your Fork

git push origin my-feature

6. Submit a Pull Request

Go to your fork on GitHub and click "New pull request".

Code Style

  • Follow PEP8 guidelines.
  • Use docstrings for all public classes and methods.
  • Use type hints where appropriate.

Reporting Issues

  • Use the GitHub Issues tab to report bugs or request features.
  • Please provide as much detail as possible.

Community

  • Be respectful and inclusive.
  • See the Code of Conduct for more information.

Submitting Issues and Pull Requests

  • Use the provided GitHub issue and pull request templates for consistency.