Skip to content

Commit 0727bd7

Browse files
authored
Break up contributor guide for better navigability (microsoft#2250)
* contributor guide * update
1 parent cef642b commit 0727bd7

13 files changed

+286
-280
lines changed

website/docs/Contribute.md

-269
This file was deleted.

website/docs/Getting-Started.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ The figure below shows an example conversation flow with AutoGen.
131131
- Follow on [Twitter](https://twitter.com/pyautogen)
132132
- See our [roadmaps](https://aka.ms/autogen-roadmap)
133133

134-
If you like our project, please give it a [star](https://github.com/microsoft/autogen/stargazers) on GitHub. If you are interested in contributing, please read [Contributor's Guide](/docs/Contribute).
134+
If you like our project, please give it a [star](https://github.com/microsoft/autogen/stargazers) on GitHub. If you are interested in contributing, please read [Contributor's Guide](/docs/contributor-guide/contributing).
135135

136136
<iframe
137137
src="https://ghbtns.com/github-btn.html?user=microsoft&amp;repo=autogen&amp;type=star&amp;count=true&amp;size=large"
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Contributing to AutoGen
2+
3+
This project welcomes and encourages all forms of contributions, including but not limited to:
4+
5+
- Pushing patches.
6+
- Code review of pull requests.
7+
- Documentation, examples and test cases.
8+
- Readability improvement, e.g., improvement on docstr and comments.
9+
- Community participation in [issues](https://github.com/microsoft/autogen/issues), [discussions](https://github.com/microsoft/autogen/discussions), [discord](https://aka.ms/autogen-dc), and [twitter](https://twitter.com/pyautogen).
10+
- Tutorials, blog posts, talks that promote the project.
11+
- Sharing application scenarios and/or related research.
12+
13+
Most contributions require you to agree to a
14+
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
15+
the rights to use your contribution. For details, visit <https://cla.opensource.microsoft.com>.
16+
17+
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.
18+
19+
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
20+
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
21+
provided by the bot. You will only need to do this once across all repos using our CLA.
22+
23+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
24+
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
25+
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
26+
27+
## Roadmaps
28+
29+
To see what we are working on and what we plan to work on, please check our
30+
[Roadmap Issues](https://aka.ms/autogen-roadmap).
31+
32+
## Becoming a Reviewer
33+
34+
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.
+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Docker for Development
2+
3+
For developers contributing to the AutoGen project, we offer a specialized Docker environment. This setup is designed to streamline the development process, ensuring that all contributors work within a consistent and well-equipped environment.
4+
5+
## Autogen Developer Image (autogen_dev_img)
6+
7+
- **Purpose**: The `autogen_dev_img` is tailored for contributors to the AutoGen project. It includes a suite of tools and configurations that aid in the development and testing of new features or fixes.
8+
- **Usage**: This image is recommended for developers who intend to contribute code or documentation to AutoGen.
9+
- **Forking the Project**: It's advisable to fork the AutoGen GitHub project to your own repository. This allows you to make changes in a separate environment without affecting the main project.
10+
- **Updating Dockerfile**: Modify your copy of `Dockerfile` in the `dev` folder as needed for your development work.
11+
- **Submitting Pull Requests**: Once your changes are ready, submit a pull request from your branch to the upstream AutoGen GitHub project for review and integration. For more details on contributing, see the [AutoGen Contributing](https://microsoft.github.io/autogen/docs/Contribute) page.
12+
13+
## Building the Developer Docker Image
14+
15+
- To build the developer Docker image (`autogen_dev_img`), use the following commands:
16+
17+
```bash
18+
docker build -f .devcontainer/dev/Dockerfile -t autogen_dev_img https://github.com/microsoft/autogen.git#main
19+
```
20+
21+
- For building the developer image built from a specific Dockerfile in a branch other than main/master
22+
23+
```bash
24+
# clone the branch you want to work out of
25+
git clone --branch {branch-name} https://github.com/microsoft/autogen.git
26+
27+
# cd to your new directory
28+
cd autogen
29+
30+
# build your Docker image
31+
docker build -f .devcontainer/dev/Dockerfile -t autogen_dev-srv_img .
32+
```
33+
34+
## Using the Developer Docker Image
35+
36+
Once you have built the `autogen_dev_img`, you can run it using the standard Docker commands. This will place you inside the containerized development environment where you can run tests, develop code, and ensure everything is functioning as expected before submitting your contributions.
37+
38+
```bash
39+
docker run -it -p 8081:3000 -v `pwd`/autogen-newcode:newstuff/ autogen_dev_img bash
40+
```
41+
42+
- Note that the `pwd` is shorthand for present working directory. Thus, any path after the pwd is relative to that. If you want a more verbose method you could remove the "`pwd`/autogen-newcode" and replace it with the full path to your directory
43+
44+
```bash
45+
docker run -it -p 8081:3000 -v /home/AutoGenDeveloper/autogen-newcode:newstuff/ autogen_dev_img bash
46+
```
47+
48+
## Develop in Remote Container
49+
50+
If you use vscode, you can open the autogen folder in a [Container](https://code.visualstudio.com/docs/remote/containers).
51+
We have provided the configuration in [devcontainer](https://github.com/microsoft/autogen/blob/main/.devcontainer). They can be used in GitHub codespace too. Developing AutoGen in dev containers is recommended.

0 commit comments

Comments
 (0)