swarms/CONTRIBUTING.md

Contributing to Swarms 🛠️

Thank you for your interest in contributing to Swarms! This guide will help you get started with your contribution.

Essential Steps for Contributing

1. Fork and Clone the Repository

1. Fork the Swarms repository to your GitHub account by clicking the "Fork" button in the top-right corner of the repository page.
2. Clone your forked repository to your local machine:

   git clone https://github.com/kyegomez/swarms.git
   

2. Make Changes

1. Create a new branch for your changes:

   git checkout -b your-branch-name
   

2. Make your desired changes to the codebase.

3. Commit and Push Changes

1. Stage your changes:

   git add .
   

2. Commit your changes:

   git commit -m "Your descriptive commit message"
   

3. Push your changes to your fork:

   git push -u origin your-branch-name
   

4. Create a Pull Request

1. Go to the original Swarms repository on GitHub.
2. Click on "Pull Requests" and then "New Pull Request".
3. Select your fork and branch as the compare branch.
4. Click "Create Pull Request".
5. Fill in the pull request description and submit.

Important Considerations

• Ensure your code follows the project's coding standards.
• Include tests for new features or bug fixes.
• Update documentation as necessary.
• Make sure your branch is up-to-date with the main repository before submitting a pull request.

Additional Information

Code Quality

We use pre-commit hooks to maintain code quality. To set up pre-commit:

1. Install pre-commit:

   pip install pre-commit
   

2. Set up the git hook scripts:

   pre-commit install
   

Documentation

• We use mkdocs for documentation. To serve the docs locally:

  mkdocs serve
  

Testing

• Run tests using pytest:

  pytest
  

For more detailed information on code quality, documentation, and testing, please refer to the full contributing guidelines in the repository.