jizzel / algo-dsa

leetcode
0 stars 0 forks source link

LeetCode Solutions - Python & Java

Image Description

Table of Contents

What You'll Find:

This repository serves as a collaborative platform for our daily LeetCode problem-solving adventures!

What You'll Find:

How to Use:

Run Java Solutions:

Why Collaborate?

Wanna contribute?

Looking Ahead:

Feel free to contribute your solutions, insights, and improvements to this collaborative learning space!



Contributing to LeetCode Solutions Repository

Thank you for your interest in contributing to our LeetCode solutions repository! We appreciate your help in making this project more comprehensive and useful for everyone.

Authors

This project is currently maintained and contributed to by:

- Joseph Afriyie Attakorah (Java solutions)
- Abigail Woolley (Python solutions)

Table of Contents

Getting Started

Fork the Repository

  1. Fork this repository to your GitHub account by clicking the "Fork" button at the top right of this page.
  2. Clone the forked repository to your local machine using:
    git clone https://github.com/your-username/repo-name.git
  3. Navigate to the project directory:
    cd repo-name

Set Up Your Local Environment

Ensure that you have the necessary tools installed to run the LeetCode solutions in your language of choice.

How to Contribute

Adding a New Solution

  1. Create a new branch:

    git checkout -b feature/new-solution
  2. Write the code:

    • Follow the existing directory structure:
      • Place Python solutions in the python/ directory.
      • Place Java solutions in the java/ directory.
  3. Add test cases:

    • Include test cases in the same file (for simplicity) or in a dedicated tests/ directory.
  4. Commit your changes:

    • Write clear and concise commit messages:
      git add .
      git commit -m "feat: Add solution for LeetCode 0020: Valid Parentheses"
  5. Push your branch:

    git push origin feature/new-solution
  6. Create a Pull Request:

    • Go to the repository on GitHub, and you’ll see an option to create a Pull Request (PR).
    • Fill in the PR template, including details about the problem solved, the approach used, and any other relevant information.

Updating an Existing Solution

  1. Follow the same steps as adding a new solution, but instead of creating a new file, modify the existing one.
  2. Clearly describe what changes you made and why in the commit message and PR description.

Code Style

Pull Request Process

  1. Ensure that your code passes all tests before submitting the PR.
  2. Fill out the PR template completely and accurately.
  3. Await review from project maintainers. They might request changes or provide feedback.
  4. Once your PR is approved, it will be merged into the main branch.

Issue Reporting

If you encounter any issues or bugs while using the repository, please feel free to open an issue on GitHub. Provide a detailed description of the issue, steps to reproduce it, and any relevant screenshots or logs.

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the repository maintainers.


Questions?

If you have any questions about contributing or need help, feel free to reach out by opening an issue or contacting the maintainers directly.