Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
81 lines (56 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

81 lines (56 loc) · 1.94 KB
Raw

Contributing to LeetTools

Thank you for considering contributing to LeetTools! We appreciate your time and effort in improving this project. The following is a set of guidelines to help you contribute effectively.

How Can You Contribute?

There are several ways you can contribute to this project:

  • Reporting Bugs
  • Suggesting New Tools and Features
  • Fixing Issues
  • Improving Documentation
  • Writing Tests
  • Helping Other Contributors

Contributing Workflow

Reporting Bugs

If you find a bug:

  1. Search the issue tracker to see if it has already been reported.
  2. If it hasn't, open a new issue and include:
    • A descriptive title
    • Steps to reproduce the bug
    • Expected behavior
    • Screenshots or logs, if applicable

Suggesting New Tools and Features

If you have an idea for improvement:

  1. Create a post in the discussion sectiondescribing your idea.
  2. Discuss your idea with the maintainers and community.

Submitting Code Changes

  1. Fork the repo and create a new branch for your feature or bug fix: 
    git checkout -b feature/your-feature-name
  2. Make your changes.
  3. Write clear commit messages. 
    git commit -m "Add detailed description of your changes"
  4. Push your changes to your fork: 
    git push origin feature/your-feature-name
  5. Open a pull request on the repository.

Coding Guidelines

  • Follow the project's coding style.
  • Write descriptive comments where necessary.
  • Ensure your code is tested thoroughly.

Community Support

Need help? Reach out to the community via:

Thank you for contributing to LeetTools! Together, we can make this project better for everyone!