Skip to content

Latest commit

 

History

History
64 lines (47 loc) · 2.62 KB

CONTRIBUTION.md

File metadata and controls

64 lines (47 loc) · 2.62 KB

Contributing to DSA in Python

Thank you for your interest in contributing to the Data Structures and Algorithms (DSA) repository! We are excited to have you participate in making this resource more useful to the community.

How You Can Contribute

There are many ways you can contribute to this project:

  1. Bug Fixes: If you find a bug in any of the implementations or documentation, feel free to open an issue or submit a pull request with a fix.
  2. Enhancements: If you think any of the algorithms or data structures could be improved or optimized, feel free to propose enhancements.
  3. New Algorithms or Data Structures: If you want to add a new data structure or algorithm to this repository, you can fork the repo and create a new directory for your addition.
  4. Documentation: Contributions to documentation (including improving explanations, examples, or adding new markdown files for better clarity) are highly appreciated.

How to Contribute

  1. Fork the repository

    • Go to the repository page on GitHub and click on the Fork button.
    • This will create a copy of the repository in your GitHub account.

  2. Clone your fork

    • After forking, clone the repository to your local machine: 
      git clone https://github.com/mmabiaa/dsa-in-python.git

  3. Create a branch

    • Navigate to the project directory and create a new branch: 
      git checkout -b your-branch-name

  4. Make changes

    • Make your changes to the Python code and/or markdown documentation.
    • Ensure your changes are well-tested.

  5. Commit your changes

    • After making changes, commit them with a clear, concise message: 
      git commit -m "Description of the change"

  6. Push your changes

    • Push your changes to your forked repository: 
      git push origin your-branch-name

  7. Create a Pull Request

    • After pushing your changes, go to the GitHub repository and click on New Pull Request.
    • Select your branch and create the pull request.
    • Describe the changes you have made and why they are necessary.

Code Style

Please follow the following guidelines when making changes:

  • Use PEP 8 for Python code formatting.
  • Include comments explaining why certain decisions are made.
  • Ensure that the code is readable and easy to understand.

Issues

If you encounter any issues or bugs while using the repository, feel free to open an issue on GitHub. Please provide detailed steps to reproduce the issue and any error messages that might help in diagnosing the problem.

Thank you for contributing!