Skip to content

Latest commit

 

History

History
80 lines (54 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

80 lines (54 loc) · 2.6 KB

Contributing to DSA POTD - Hacktoberfest 2024

Thank you for considering contributing to this repository! 🎉
To keep everything organized and ensure quality contributions, please take a moment to review these guidelines.

📝 General Contribution Guidelines

  1. Fork the Repository: Use the "Fork" button at the top to create your own copy of the repository.
  2. Create a Branch: Work on your own branch for making changes.
    git checkout -b feature/your-feature-name
    

Commit Message Guidelines

  • Use meaningful commit messages that explain what changes have been made.
  • Example: Added Python solution for Two Sum problem.

Pull Request (PR) Guidelines

  1. Ensure your code works before submitting (run tests if applicable).
  2. Add comments explaining your code, especially if it uses complex logic.
  3. Include the issue number you are addressing (e.g., Fixes #123).
  4. Run prettier or other code formatters if applicable to ensure your code is well-structured.

Coding Style

  1. Follow the code style conventions for your programming language:
    • PEP8 for Python.
    • Google Java Style for Java.
  2. Use descriptive variable names to make the code more readable.
  3. Write clean, maintainable code:
    • Avoid large, monolithic functions—break them down into smaller, testable units.

🤖 Workflow for Contributing

  1. Clone Your Fork

    git clone https://github.com/<your-username>/LeetCode_POTD_Hacktoberfest2024.git
    
  2. Create a New Branch

    git checkout -b your-feature-branch
    
  3. Make Your Changes

  • Implement your solution or update existing code.
  • Test Your Changes: Ensure your solution works correctly and is efficient.
  1. Commit and Push

    git add .
    git commit -m "Added solution for Problem XYZ"
    git push origin your-feature-branch
    

Open a Pull Request

  1. Go to the original repository.
  2. Click on the Pull Requests tab and open a new pull request from your branch.
  3. Add a descriptive title and link the issue you are addressing.

👩‍💻 Contribution Types

  • New Solutions: Solve a new LeetCode Problem of the Day.
  • Optimize Existing Solutions: Improve the efficiency or readability of existing solutions.
  • Documentation: Add problem descriptions, explanations, or comments.

🤝 Code of Conduct

Please respect fellow contributors. Make sure to follow the Code of Conduct in all interactions.


Thank you for contributing! Let’s make this project a valuable resource for everyone participating in Hacktoberfest 2024.