Skip to content

Latest commit

 

History

History
137 lines (98 loc) · 4.17 KB

CONTRIBUTING.md

File metadata and controls

137 lines (98 loc) · 4.17 KB

Contributing guidelines

Before contributing

Welcome to Daily Coding Problem Solutions! Before sending your pull requests, make sure that you read the whole guidelines.

Contributing

Contributor

Thankyou for considering improvising the solutions in this repository! Being one of our contributors, you agree and confirm that:

  • Your work will be distributed under MIT License once your pull request is merged.
  • You submitted work fulfills the styles and standards of this repository.

Contribution

Any contribution, from fixing a grammatical errors in a comment to improvising current solutions is appriciated.

New implementation is welcome as long as the solution improvises the Time Complexity and/or Space Complexity without deteriorating the either of them compared to the current solution. But identical implementation of an existing solution will not be accepted.

Improving comments are also highly welcome. But fake pull requests, like unnecessarily changing the wording, adding 'a' or 'the', etc are highly discouraged. Such pull requests will be closed immediately and labeled as invalid.

  1. If you are a first-time contributor:

    • Go to https://github.com/ruppysuppy/Daily-Coding-Problem-Solutions and click the fork button to create your own copy of the project.

    • Clone the project to your local computer:

      git clone https://github.com/<your-username>/Daily-Coding-Problem-Solutions.git

    • Change the directory:

      cd Daily-Coding-Problem-Solutions

    • Add the upstream repository:

      git remote add upstream https://github.com/ruppysuppy/Daily-Coding-Problem-Solutions.git

    • Now, git remote -v will show two remote repositories named:

      • upstream: which refers to the original repository in GitHub
      • origin: which refers to your personal fork

  2. Develop your contribution:

    • Pull the latest changes from upstream:

      • git checkout master

      • git pull upstream master

    • Create a branch for the feature you want to work on. Since the branch name will appear in the merge message, use a sensible name such as problem-200-optimization:

      git checkout -b problem-200-optimization

    • Commit locally as you progress (git add . and git commit -m "<you message>"). Use a self-explanatory commit message.

  3. To submit your contribution:

    • Push your changes back to your fork on GitHub:

      git push origin problem-200-optimization

    • Enter your GitHub username and password (repeat contributors or advanced users can remove this step by connecting to GitHub with SSH).

    • Go to GitHub. The new branch will show up with a green Pull Request button. Make sure the title and message are clear, concise, and self-explanatory. Then click the button to submit it.

Other Requirements for Submissions

  • Use black to format you code.

  • Strictly use PascalCase for class names and snake_case in your variable and function names.

  • If you have modified/added documentation work, ensure your language is concise and contains no grammatical errors.

  • If you have modified/added code work, make sure the code compiles before submitting.

  • Make sure to add Python type hints to all functions and methods.

  • Make sure to follow this pattern for any solution:

    """
Problem:

<Problem Statement>
"""

# ...
# necessary functions
# ...


if __name__ == "__main__":
    # an example for the solution


"""
SPECS:

<time & space complexity>
"""

  • Most importantly,

    • Be consistent in the use of these guidelines when submitting.
    • Happy coding!