Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 2.14 KB

CONTRIBUTE.md

File metadata and controls

58 lines (38 loc) · 2.14 KB
Raw

Contribution Guidelines 🤝

Thank you for considering contributing to our community! Your contributions are invaluable in building it. Follow these guidelines to contribute effectively:

Getting Started 🚀

  1. Fork the project by visiting genai-engineering-thailand.github.io on GitHub and click the "Fork" button.

  2. Clone your forked repository to your local machine.

git clone https://github.com/genai-engineering-thailand/genai-engineering-thailand.github.io.git

Create a new branch for your contribution.

git checkout -b docs/your-docs

Making Changes 🛠️

  1. Explore the /docs folder and think about what you would like to contribute.

  2. Implement your changes or improvements, including code, information, and any form of material you find suitable. You may create new knowledge category, but keep it organized and aligned with others.

  3. Feel free to include notebooks, markdown article, images, diagrams (preferrbly mermaid), or any relevant media to support the explanation. Using submodules approach is applicable.

  4. Ensure the material can be rendered in our website properly using MKDocs.

Committing Changes 📝

  1. Commit your changes with a descriptive commit message. We encourage you to use Conventional Commits.
git commit -m "docs: add ABC content to docs folder"
  1. Push your changes to your forked repository.
git push origin docs/your-docs

Creating a Pull Request (PR) 📥

  1. Go to the original repository on GitHub.
  2. Click on the "Pull Requests" tab.
  3. Click the "New Pull Request" button.
  4. Choose the branch with your changes.
  5. Describe your changes in the pull request and provide any necessary context.
  6. Submit the pull request.

Code Review ✅

Once your pull request is submitted, it will undergo a review. Be open to feedback and address any comments or suggestions made by maintainers or contributors.

Contribution Acceptance 🎉

After a successful review, your contribution will be merged into the main repository.

Happy sharing! 🌐📚