Thank you for your interest in contributing to generative-AI! I appreciate your time and effort in helping to improve my project. Before you get started, please take a moment to review these guidelines.
- Getting Started
- Contributing
- Coding Guidelines
- Testing
- Documentation
- Community and Communication
- Acknowledgments
- Python [Version]
- Ipython [Version]
- Jupyter Notebooks [Version]
- Conda
- macOS or GNU/Linux
- Clone the repository:
git clone https://github.com/Aisuko/generative-ai.git - Navigate to the project directory:
cd generative-ai - Install the required dependencies:
make installimp
We welcome contributions from everyone! To get started, follow these steps:
If you find a bug, have a feature request, or encounter any issues, please check the issue tracker to see if a similar issue has already been reported. If not, feel free to create a new issue and provide as much detail as possible.
- Fork the repository.
- Create a new branch with a descriptive name:
git checkout -b [branch name] - Make your changes and commit them.
- Push the changes to your fork:
git push origin [branch name] - Create a new pull request from your branch to the main project's
mainormasterbranch. - Provide a clear description of your changes in the pull request.
- Make any requested changes during the review process.
- Once your PR is approved, it will be merged into the main project.
- No specific coding guidelines at the moment. Please make sure the notebook is well documented and easy to follow.
- If the notebook can be run succesfully on Kaggle, it is considered as tested.
- We are all new in this field, more documentation is needed. And you will get a deep understanding of the topic by writing documentation.
- You can reach out via the Github issue tracker.
We value and appreciate your contributions. All contributors will be acknowledged in the project's acknowledgments file.
Thank you for being a part of gernative-AI!