Want to contribute to this project? ✨ Click here to learn more. 📝 We are also working on a related survey paper. Stay tuned for updates!
Wanna contribute? Check out the guidelines

Contribution

Hi everyone! Thanks for the help!! Your expertise is invaluable to the community 💡. Here are some steps to contribute to the repository:

Installation

After cloning this repo, we can start the installation. This repo supports Python 3.9 and above. In one line, to use a virtual environment, e.g. with anaconda3:

conda create -n awesome-social-agents python=3.9; conda activate awesome-social-agents; python -m install requirements.txt

For developing the website,

curl -fsSL https://bun.sh/install | bash # install bun
bun i # install dependencies
bun run dev # run dev server (auto reload)
# bun run build # if you wanna build

In next.config.js. you should set the basepath to "" in your local machine, but make sure not to commit it since github page requires it.

Steps

  1. Fork the repository.

  2. Add each paper to the main.bib file, under the section you are working on. You could pick one section that fits the paper the most. This file will sync with the Overleaf project main.bib file after your PR is merged. Don't add the papers that are already in the main.bib.

  3. Add four new fields for each paper you added: environments, agents, evaluation, and other. The acceptable tags for these four fields are in taxonomy (opens in a new tab).

  4. Update the ./docs/paper_table.md file:

    • Run python bibtex_to_table.py to update the ./docs/paper_table.md file.
    • Double-check the output Markdown file and ensure the table is updated correctly.

  5. Update the ./docs/README.md file with the paper entry:

    • Copy and paste the content from the helper column of the ./docs/helper.md file to the corresponding section(s) in the ./docs/README.md file.
    • Note: If the paper fits multiple sections, you can paste the entry into multiple sections in the ./docs/README.md file.

  6. Create a Pull Request:

    • Once you've completed the above steps, create a pull request to the main repository.
    • Congratulations! 🎉

Notes

  • If you have any questions, feel free to ask in the Slack channel or create an issue in the repository.
ReadmeTaxonomy