Skip to content

Latest commit

 

History

History
61 lines (37 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

61 lines (37 loc) · 1.62 KB

Contributing to Algorithms Repository

First of all, thank you for considering contributing to this repository! We welcome contributions from anyone willing to help improve the repository.

How to Contribute

  1. Fork the Repository

    • Click the "Fork" button on the top right of this page to create a copy of the repository in your GitHub account.
  2. Clone Your Fork

    • Clone the forked repository to your local machine:

      git clone https://github.com/programming-for-career/algorithms.git
  3. Create a New Branch

    • Before making any changes, create a new branch:

      git checkout -b your-branch-name
  4. Make Your Changes

    • Add a new algorithm or fix an issue.
  5. Commit Your Changes

    • Commit your changes with a descriptive commit message:

      git commit -m "Add [algorithm name] in [language]"
  6. Push to Your Fork

    • Push the changes to your forked repository:

      git push origin your-branch-name
  7. Submit a Pull Request

    • Go to the "Pull Requests" tab in the repository and create a new pull request.

Code Style Guidelines

  • Indentation: Use 4 spaces for indentation.
  • Naming Conventions: Use descriptive names for variables, functions, and classes.
  • Commenting: Make sure your code is well-commented, explaining your logic where necessary.
  • Keep it Simple: Always try to make your code as simple and readable as possible.

Reporting Bugs or Issues

If you find a bug or issue, feel free to open an issue in the "Issues" tab.

We appreciate your contributions!