Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (35 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

54 lines (35 loc) · 2.43 KB

Contributing to DS-Algos-Python

First off, thank you for considering contributing to this repository! It's people like you that make the open-source community such an amazing place to learn, inspire, and create.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related bugs.

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Explain which behavior you expected to see and why and why you think it's a bug.
  • Include Python version and any other relevant environment details.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Explain why this enhancement would be useful to most users.

Pull Requests

The process for submitting a pull request (PR):

  1. Fork the repository and create your branch from master.
  2. Add your implementation in the appropriate directory (e.g., Arrays/, Trees/).
  3. Include test cases at the bottom of your script to verify your solution.
  4. Update the relevant README.md (both in the root and in the subdirectory) to include your new script.
  5. Ensure your code follows PEP 8 guidelines for Python code style.
  6. Issue the PR with a clear description of your changes.

Styleguides

Python Styleguide

All Python code should follow the PEP 8 style guide.

  • Use 4 spaces per indentation level.
  • Limit all lines to a maximum of 79 characters.
  • Use snake_case for function and variable names.
  • Include descriptive comments and docstrings where appropriate.

Documentation Styleguide

  • Use Markdown for documentation.
  • When referencing complexity, use LaTeX notation (e.g., $O(n \log n)$).
  • Ensure all links are relative to the repository root where possible.

License

By contributing to this repository, you agree that your contributions will be licensed under its MIT License.