Skip to content

Latest commit

 

History

History
66 lines (41 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

66 lines (41 loc) · 1.69 KB
Raw

Contributing to AI-Algorithms-Made-Easy

Thank you for your interest in contributing to AI-Algorithms-Made-Easy! Your contributions help make AI algorithms more accessible and easy to understand for everyone.

How to Contribute

1. Fork the Repository

  • Click the "Fork" button at the top right of this repository page to create your own copy.

2. Clone Your Fork

git clone https://github.com/mboukabous/AI-Algorithms-Made-Easy.git
cd AI-Algorithms-Made-Easy

3. Create a New Branch

git checkout -b feature/your-feature-name

4. Make Your Changes

  • Implement your feature, fix a bug, or improve documentation.

5. Commit Your Changes

git commit -m "Add [description of your changes]"

6. Push to Your Fork

git push origin feature/your-feature-name

7. Open a Pull Request

  • Go to the original repository on GitHub and click on "Pull Requests".
  • Click "New Pull Request" and select your branch.
  • Provide a clear title and description of your changes.
  • Submit the pull request.

Reporting Issues

If you encounter any problems or have suggestions, please open an issue:

  1. Go to the Issues tab.
  2. Click on "New Issue".
  3. Describe the issue or suggestion clearly.

Code Guidelines

  • Meaningful Names: Use clear and descriptive names for variables, functions, and classes.
  • Documentation: Include docstrings for modules, classes, and functions.

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Contact