|
| 1 | +--- |
| 2 | +layout: default |
| 3 | +title: Community |
| 4 | +nav_order: 5 |
| 5 | +has_children: true |
| 6 | +description: community resources, getting help and sharing ideas |
| 7 | +permalink: /community |
| 8 | +--- |
| 9 | + |
| 10 | +# Community |
| 11 | + |
| 12 | +COMING SOON ... |
| 13 | + |
| 14 | + |
| 15 | +{: .note} |
| 16 | +> The contributions to `llmware` are governed by our [Code of Conduct](https://github.com/llmware-ai/llmware/blob/main/CODE_OF_CONDUCT.md). |
| 17 | +
|
| 18 | +{: .warning} |
| 19 | +> Have you found a security issue? Then please jump to [Security Vulnerabilities](#security-vulnerabilities). |
| 20 | +
|
| 21 | +On this page, we provide information ``llmware`` contributions. |
| 22 | +There are **two ways** on how you can contribute. |
| 23 | +The first is by making **code contributions**, and the second by making contributions to the **documentation**. |
| 24 | +Please look at our [contribution suggestions](#how-can-you-contribute) if you need inspiration, or take a look at [open issues](#open-issues). |
| 25 | + |
| 26 | +Contributions to `llmware` are welcome from everyone. |
| 27 | +Our goal is to make the process simple, transparent, and straightforward. |
| 28 | +We are happy to receive suggestions on how the process can be improved. |
| 29 | + |
| 30 | +## How can you contribute? |
| 31 | + |
| 32 | +{: .note} |
| 33 | +> If you have never contributed before look for issues with the tag [``good first issue``](https://github.com/llmware-ai/llmware/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22). |
| 34 | +
|
| 35 | +The most usual ways to contribute is to add new features, fix bugs, add tests, or add documentation. |
| 36 | +You can visit the [issues](https://github.com/llmware-ai/llmware/issues) site of the project and search for tags such as |
| 37 | +``bug``, ``enhancement``, ``documentation``, or ``test``. |
| 38 | + |
| 39 | + |
| 40 | +Here is a non exhaustive list of contributions you can make. |
| 41 | + |
| 42 | +1. Code refactoring |
| 43 | +2. Add new text data bases |
| 44 | +3. Add new vector data bases |
| 45 | +4. Fix bugs |
| 46 | +5. Add usage examples (see for example the issues [jupyter notebook - more examples and better support](https://github.com/llmware-ai/llmware/issues/508) and [google colab examples and start up scripts](https://github.com/llmware-ai/llmware/issues/507)) |
| 47 | +6. Add experimental features |
| 48 | +7. Improve code quality |
| 49 | +8. Improve documentation in the docs (what you are reading right now) |
| 50 | +9. Improve documentation by adding or updating docstrings in modules, classes, methods, or functions (see for example [Add docstrings](https://github.com/llmware-ai/llmware/issues/219)) |
| 51 | +10. Improve test coverage |
| 52 | +11. Answer questions in our [Discord channel](https://discord.gg/MhZn5Nc39h), especially in the [technical support forum](https://discord.com/channels/1179245642770559067/1218498778915672194) |
| 53 | +12. Post projects in which you use ``llmware`` in our Discord forum [made with llmware](https://discord.com/channels/1179245642770559067/1218567269471486012), ideially with a link to a public GitHub repository |
| 54 | + |
| 55 | +## Open Issues |
| 56 | +If you're interested in existing issues, you can |
| 57 | + |
| 58 | +- Look for issues, if you are a new to the project, look for issues with the `good first issue` label. |
| 59 | +- Provide answers for questions in our [GitHub discussions](https://github.com/llmware-ai/llmware/discussions) |
| 60 | +- Provide help for bug or enhancement issues. |
| 61 | + - Ask questions, reproduce the issues, or provide solutions. |
| 62 | + - Pull a request to fix the issue. |
| 63 | + |
| 64 | + |
| 65 | + |
| 66 | +## Security Vulnerabilities |
| 67 | +**If you believe you've found a security vulnerability, then please _do not_ submit an issue ticket or pull request or otherwise publicly disclose the issue.** |
| 68 | +Please follow the process at [Reporting a Vulnerability](https://github.com/llmware-ai/llmware/blob/main/Security.md) |
| 69 | + |
| 70 | + |
| 71 | + |
| 72 | +## GitHub workflow |
| 73 | + |
| 74 | +We follow the [``fork-and-pull``](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) Git workflow. |
| 75 | + |
| 76 | +1. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the repository on GitHub. |
| 77 | +2. Clone your fork to your local machine with `git clone git@github.com:<yourname>/llmware.git`. |
| 78 | +3. Create a branch with `git checkout -b my-topic-branch`. |
| 79 | +4. Run the test suite by navigating to the tests/ folder and running ```./run-tests.py -s``` to ensure there are no failures |
| 80 | +5. [Commit](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork) changes to your own branch, then push to GitHub with `git push origin my-topic-branch`. |
| 81 | +6. Submit a [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) so that we can review your changes. |
| 82 | + |
| 83 | +Remember to [synchronize your forked repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#keep-your-fork-synced) _before_ submitting proposed changes upstream. If you have an existing local repository, please update it before you start, to minimize the chance of merge conflicts. |
| 84 | + |
| 85 | +```shell |
| 86 | +git remote add upstream git@github.com:llmware-ai/llmware.git |
| 87 | +git fetch upstream |
| 88 | +git checkout upstream/main -b my-topic-branch |
| 89 | +``` |
| 90 | + |
| 91 | +## Community |
| 92 | +Questions and discussions are welcome in any shape or form. |
| 93 | +Please fell free to join our community on our discord channel, on which we are active daily. |
| 94 | +You are also welcome if you just want to post an idea! |
| 95 | + |
| 96 | +- [Discord Channel](https://discord.gg/MhZn5Nc39h) |
| 97 | +- [GitHub discussions](https://github.com/llmware-ai/llmware/discussions) |
0 commit comments