Skip to content

Latest commit

 

History

History
108 lines (73 loc) · 5.45 KB

CONTRIBUTING.md

File metadata and controls

108 lines (73 loc) · 5.45 KB

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

How to Contribute

We're looking for DSA enthusiasts to contribute to this repository by creating and solving DSA worksheets. Here's how you can get involved:

  1. Fork this repository: Click the "Fork" button on the top right to create your own copy.

  2. Clone your fork: Use git clone to clone your fork to your local machine:

    git clone <FORKED REPOSITORY LINK>

  3. Create a new branch: Make a new branch for your worksheet:

    git checkout -b your_name-dsa-worksheet

  4. Add your worksheet: Create a new file in the folder of your selected programming language and add your DSA problem.

  5. Commit your changes: Once you've added your worksheet, commit your changes:

    git commit -m "Add my awesome DSA worksheet"

  6. Push to your fork: Push your changes to your GitHub fork:

    git push origin your_name-dsa-worksheet

  7. Create a Pull Request (PR): Head to the original repository on GitHub and create a new PR. Our maintainers will review your PR and provide feedback.

  8. Star this Repository.

Video Tutorial

tutorial.mp4

Guidelines for Contributions

  • Please ensure that your DSA solution is clear and well-documented.
  • Create a separate folder for your solution in the "DSA_Codesheet" directory and place your worksheet file there.
  • In the "DSA_Codesheet" directory there are multiple directories for certain coding languages.
  • Make sure you submit your code in the correct language directory.
  • Feel free to create multiple solutions in your PR.
  • Make sure your code is clean, follows best practices, and is properly formatted.
  • Finally, add your name in the contributors in "README.md"

Add your name in the Contributors

  1. Edit the README.md file using any text editor, VScode for example.

  2. Below is a code snippet for reference as to what has to ADDED in the file. Inside the <b> </b> tag you have to put your name, in the <href > tag, you have to place your github profile URL. And lastly you have to place your github profile photo url inside the src tag.

    <td align="center">
    <a href="your_github_profile_url">
        <img src="=your_github_profile_picture" width="100px;" alt="your_name"/>
        <br />
        <sub><b>your_name</b></sub>
    </a>
</td>

  3. Now save your changes

Create Problem Statements

If you have a problem statement that you wish to add to this repository, feel free to do so by creating an issue. There is already a template made for DSA Questions named DSA Questions Template, follow these steps to create an issue:

  • Click on Issues
  • Click on New Issues
  • Click "Get Started" on DSA Question Template
  • Make necessary changes
  • Submit the issue. If you want to make a new issue from scratch then make sure you follow the underwritten guidelines:

  1. Title Format: The title should be concise and give a hint about the nature of the problem.

  2. Problem Description: copy the raw code of the issue template and paste it in the issue description and add the additional requirements.

  3. Tags/Labels: Add relevant tags or labels to help categorize the problem. Every problem must have labels for programming language (Python, C, C++, Java) as well as 1 label for difficulty level (Level: Easy, Level: Medium, Level: Hard). To make the problem elegible for Hacktoberfest, add the hacktoberfest-2023 label as well.

  4. General Rules:

    1. Uniqueness: Before creating an issue, please search the existing issues to avoid duplicates.

    2. Clarity: Ensure the problem statement is clear. Ambiguous problem statements can confuse contributors.

    3. Stay Updated: If someone asks a question or needs clarification on your issue, try to respond promptly.

    4. Constructive Feedback: If you're referencing a problem from another platform or book, ensure you're not violating any copyright rules. Always give credit where it's due.

    5. No Spoilers: If you're also providing a solution, please don't post it directly in the issue. We want to give others a chance to solve it. Instead, consider creating a pull request with the solution, or linking to a separate solution discussion.

Note that any issue that doesn't abide by this guideline will be closed immediately.

Getting Help

If you have any questions or need assistance, feel free to open an issue or reach out to our community in the discussion section.

We're excited to see your contributions and help you in your DSA journey. Happy Hacking!

License

This repository is open-source and available under the MIT License.


Feel free to customize this README to suit your repository's specific requirements. Be sure to include clear guidelines for contributions, information about how to participate in Hacktoberfest, and any other details that are relevant to your project.