Skip to content

Latest commit

 

History

History
53 lines (39 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

53 lines (39 loc) · 1.76 KB

Contributing to the AI Engineering Series

🎯 Want to contribute to the AI Engineering Series?
We welcome bug fixes, improvements, and new exercises!

Steps to Contribute:

  1. Fork this repository.
  2. Commit your code and push the changes.
  3. Open a pull request and describe your updates.

Uploading Example Exercises:

To upload your example exercises, follow these steps:

  1. Navigate to the relevant section folder (e.g., AI-Engineering-Essentials/Part1/Section3/).
  2. Inside the section folder, locate the community-contributions folder.
  3. Create a new folder with your first and last name (e.g., shaheer-airaj).
  4. Place all your code files inside this folder.

The folder structure should look like this:

AI-Engineering-Essentials/
├── Part1/
│   ├── Section3/
│   │   ├── community-contributions/
│   │   │   ├── shaheer-airaj/
│   │   │   │   ├── submission.py
│   │   │   │   ├── additional_file.ipynb
│   │   │   │   └── ...
│   │   ├── other_files/
│   ├── Section4/
│   │   ├── community-contributions/
│   │   │   ├── shaheer-airaj/
│   │   │   │   ├── submission.py
│   │   │   │   ├── additional_file.ipynb
│   │   │   │   └── ...
│   │   ├── other_files/

Additional Guidelines:

  • Ensure your code is well-documented.
  • Include comments and explanations where necessary to help others understand your code.

Thank you for contributing to the AI Engineering Series! Your efforts help improve the learning experience for everyone.

If you have any questions or need assistance, feel free to reach out via GitHub Issues or Discussions.

Happy coding! 🚀