autogen/website/docs/Contribute.md

65 lines
3.5 KiB
Markdown
Raw Normal View History

2023-08-30 16:50:59 -04:00
# Contributing
This project welcomes and encourages all forms of contributions, including but not limited to:
- Pushing patches.
- Code review of pull requests.
- Documentation, examples and test cases.
- Readability improvement, e.g., improvement on docstr and comments.
2023-09-02 21:58:13 -04:00
- Community participation in [issues](https://github.com/microsoft/autogen/issues), [discussions](https://github.com/microsoft/autogen/discussions), and discord.
2023-08-30 16:50:59 -04:00
- Tutorials, blog posts, talks that promote the project.
- Sharing application scenarios and/or related research.
Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit <https://cla.opensource.microsoft.com>.
If you are new to GitHub [here](https://help.github.com/categories/collaborating-with-issues-and-pull-requests/) is a detailed help source on getting involved with development on GitHub.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## How to make a good bug report
When you submit an issue to [GitHub](https://github.com/microsoft/autogen/issues), please do your best to
follow these guidelines! This will make it a lot easier to provide you with good
feedback:
- The ideal bug report contains a short reproducible code snippet. This way
anyone can try to reproduce the bug easily (see [this](https://stackoverflow.com/help/mcve) for more details). If your snippet is
longer than around 50 lines, please link to a [gist](https://gist.github.com) or a GitHub repo.
- If an exception is raised, please **provide the full traceback**.
- Please include your **operating system type and version number**, as well as
your **Python, autogen, scikit-learn versions**. The version of autogen
can be found by running the following code snippet:
```python
2023-08-30 17:27:35 -04:00
import autogen
print(autogen.__version__)
2023-08-30 16:50:59 -04:00
```
- Please ensure all **code snippets and error messages are formatted in
appropriate code blocks**. See [Creating and highlighting code blocks](https://help.github.com/articles/creating-and-highlighting-code-blocks)
for more details.
## Becoming a Reviewer
There is currently no formal reviewer solicitation process. Current reviewers identify reviewers from active contributors. If you are willing to become a reviewer, you are welcome to let us know on discord.
## Developing
2023-09-02 21:58:13 -04:00
Please find the a general developing guide for AutoGen in FLAML [here](https://microsoft.github.io/FLAML/docs/Contribute#developing).
Detailed guidence for developing with AutoGen will be added soon.
2023-08-30 16:50:59 -04:00
Note:
some tips in this guide are based off the contributor guide from [ray](https://docs.ray.io/en/latest/ray-contribute/getting-involved.html), [scikit-learn](https://scikit-learn.org/stable/developers/contributing.html), [hummingbird](https://github.com/microsoft/hummingbird/blob/main/CONTRIBUTING.md), or [FLAML](https://microsoft.github.io/FLAML/docs/Contribute).