Skip to content

Latest commit

 

History

History
107 lines (67 loc) · 3.14 KB

CONTRIBUTING.md

File metadata and controls

107 lines (67 loc) · 3.14 KB
Raw

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/aiplanethub/genai-stack/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

GenAI Stack could always use more documentation, whether as part of the official GenAI Stack docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/aiplanethub/genai-stack/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here's how to set up genai_stack for local development.

  1. Fork the genai_stack repo on GitHub.

  2. Clone your fork locally

    git clone git@github.com:your_name_here/genai_stack.git

  3. Install Poetry for managing dependencies. If you haven't installed Poetry yet, follow the instructions at https://python-poetry.org/docs/ to get it set up.

  4. Install your local copy into a virtualenv using Poetry::

    cd genai_stack/
poetry install

  5. Create a branch for local development

    git checkout -b <name-of-your-bugfix-or-feature>

    Now you can make your changes locally.

  6. When you need to add or update a dependency, use Poetry. For example, to add a new dependency::

    poetry add <package-name>

    Or to update an existing dependency::

    poetry update <package-name>

  7. When you're done making changes, check that your changes pass all the tests tests, including testing other Python versions.

  8. Commit your changes and push your branch to GitHub

    git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

  9. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.

  2. If the pull request adds functionality, the docs should be updated.

  3. The pull request should work for Python 3.8, 3.9, 3.10 and make sure that the tests pass for all supported Python versions in different platforms like Linux, Mac, Windows.