Skip to content

📢 Announcement: How to Contribute to the Agent Contributions Library

Jump to bottom
armlynobinguar edited this page Sep 2, 2024 · 1 revision

📢 Announcement: How to Contribute to the Agent Contributions Library

Dear Contributors,

We're excited to have you contribute to the Agent Contributions Library! To ensure a smooth collaboration process, please follow the step-by-step guide below for submitting your contributions:

Step-by-Step Guide to Contributing

1. Fork the Repository

2. Clone Your Forked Repository

  • On your GitHub profile, go to your forked repository.
  • Click the "Code" button and copy the URL.
  • Open Terminal or Command Prompt and run the following commands:
git clone https://github.com/your-username/agent-contributions-library.git
cd agent-contributions-library

3. Create a New Branch

  • Create and switch to a new branch for your feature. Please use the following naming convention:
  • dataset/[character_name]Group[number]
  • For example, if you're working on a dataset for "Ansem" in Group 4, you would use:
git checkout -b dataset/AnsemGroup4

4. Make Your Changes

  • Navigate to the character-datasets folder and make your changes.

5. Stage and Commit Your Changes

  • Stage all your changes:
git add .
  • Commit the changes with a message:
git commit -m "Added new character datasets for Ansem Group 4"

6. Push Your Changes

  • Push your branch to your GitHub fork:
git push origin dataset/AnsemGroup4

7. Create a Pull Request

  • Go to your forked repository on GitHub.
  • Navigate to the "Pull Requests" tab and click "New Pull Request."
  • Make sure the base repository is Virtual-Protocol/agent-contributions-library and the base branch is main.
  • Set the compare branch to your feature branch (dataset/AnsemGroup4).
  • Add a meaningful title and description, then click "Create Pull Request."

Thank you for your contributions! If you have any questions, feel free to ask in the discussion thread. We're here to help.

Happy coding! 🚀

Clone this wiki locally