Skip to content

Latest commit

 

History

History
168 lines (116 loc) · 6.09 KB

CONTTRIBUTE.MD

File metadata and controls

168 lines (116 loc) · 6.09 KB

Contributing to LeetCode_Daily_Task

Thank you for your interest in contributing to LeetCode_Daily_Task!

Table of Contents

How to Contribute

  1. Fork the Repository:
    Click the Fork button on the repository page to create your own copy.

  2. Clone Your Fork:

    git clone https://github.com/your-username/LeetCode_Daily_Task.git

  3. Create a Branch:
    Create a new branch for your feature, solution, or bug fix.

    git checkout -b feature/your-feature-name

  4. Implement Your Changes:

    • Add your solution or enhancements.
    • Include any discussion points or explanations in your code comments or PR description.
    • Follow the coding guidelines (see below).
    • Update or add test cases as needed.

  5. Commit Your Changes:
    Use clear and descriptive commit messages (see Commit Message Guidelines).

  6. Open a Pull Request:
    Submit a pull request (PR) with a clear title and description outlining your changes, and reference any related issues.

Impressive Contributions & Highlights

We love to see innovative and creative solutions! This section is dedicated to showcasing impressive contributions that go beyond the daily task:

  • What to Share:

    • Enhanced Solutions: Share optimized, creative, or particularly elegant approaches to LeetCode problems.
    • Detailed Explanations: Provide in-depth explanations and insights that help others understand your reasoning.
    • Additional Context: Include performance comparisons, alternative methods, or advanced techniques.

  • How to Get Recognized:
    The first contributor to submit an impressive solution for a given challenge will have their name highlighted in this section. For example:

    **Impressive Contribution by:** @username

    To be recognized, please send an email with your GitHub username and Gmail address to optimismeducator@gmail.com. This helps us track and celebrate innovative contributions.

  • Discussion:
    Engage with others by discussing alternative approaches or asking questions in the issue tracker or PR comments. Your input can help refine the solution and inspire further improvements.

Contributor Recognition Process

  • How It Works:
    Exceptional contributions are recognized to encourage innovative thinking.

  • Steps to Get Recognized:

    1. Submit your solution via a PR.
    2. Once your PR is merged, send an email with your GitHub username and Gmail address to optimismeducator@gmail.com.
    3. Your details will be added to the "Impressive Contributions & Highlights" section for that challenge.

Share Your Thoughts

We welcome your feedback and ideas!

  • Questions & Suggestions: Open an issue or start a discussion if you have ideas for improvements, new challenges, or if you need help.
  • Solution Explanations: Share your approach and insights to help others understand the problem better.
  • Improvements: If you see a more efficient or elegant solution, feel free to contribute your version.

Issue Reporting

  • Found a Bug or Have a Suggestion?
    Open a new issue on GitHub with a descriptive title and details on how to reproduce the problem or suggest improvements.
  • Include the Following Information:
    • A clear explanation of the issue.
    • Steps to reproduce the problem.
    • Environment details if applicable (e.g., OS, specific LeetCode problem IDs).

Pull Request Process

  1. Ensure Tests Pass:
    Verify that your changes pass all existing tests. If you’re adding new functionality, please include corresponding tests.

  2. Provide a Descriptive Title:
    Your PR title should succinctly describe your changes (e.g., "Add optimized solution for Two Sum challenge").

  3. Detailed Description:
    In your PR, include:

    • The purpose of your changes.
    • Instructions on how to test your changes.
    • Additional context, screenshots, or references to related issues.
    • If you're submitting an impressive solution, include a note so we can update the recognition section.

  4. Review & Feedback:
    Your PR will be reviewed by the maintainers. Please address any feedback or requested changes promptly.

Coding Guidelines

  • Consistent Formatting:
    Follow the repository’s established style for code formatting, naming conventions, and folder structure.

  • Comment Your Code:
    Provide clear comments explaining your logic, especially for complex solutions.

  • Efficiency and Readability:
    Ensure your solutions are optimized for performance and are easy to understand.

  • Documentation:
    Update or add documentation if your changes affect existing functionality.

Commit Message Guidelines

  • Short & Descriptive:
    The first line of your commit message should be a brief summary (50 characters or less).

  • Imperative Mood:
    Use the imperative mood (e.g., "Add", "Fix", "Update").

  • Detailed Description:
    If necessary, include a detailed description after the first line, separated by a blank line.

Example:

Add solution for Two Sum problem

This commit introduces an optimized solution for the Two Sum problem, along with test cases and documentation.

Acknowledgments

Thank you for contributing to LeetCode_Daily_Task!
Your help and commitment make this project a valuable resource for the community. If you have any questions or need further assistance, feel free to open an issue or contact the maintainers.

Happy coding and happy LeetCoding! 🚀