Hugging Face's logo

AbdulElahGwaith
/
Mini-Agent

Arabic
English
agent
mini-agent
mini
Model card Files
xet
 Community
Mini-Agent / CONTRIBUTING.md
AbdulElahGwaith's picture
AbdulElahGwaith
Add CONTRIBUTING.md to guide contributors
a7e542c verified
preview code
|
raw
history blame contribute delete
2.3 kB

Contributing to Mini-Agent

We welcome contributions to the Mini-Agent project! To ensure a smooth and collaborative process, please follow these guidelines.

How to Contribute

1. Fork the Repository

Start by forking the AbdulElahGwaith/Mini-Agent repository to your GitHub account.

2. Clone Your Fork

Clone your forked repository to your local machine:

git clone https://github.com/YOUR_USERNAME/Mini-Agent.git
cd Mini-Agent

3. Create a New Branch

Create a new branch for your feature or bug fix. Use a descriptive name:

git checkout -b feature/your-feature-name
# or
git checkout -b bugfix/issue-description

4. Make Your Changes

  • Write clear, concise, and well-documented code.
  • Ensure your code adheres to the project's coding style.
  • Add or update tests as appropriate for your changes.

5. Test Your Changes

Before submitting a pull request, make sure all existing tests pass and your new tests cover your changes.

# Example: Run project tests
python -m unittest discover tests

6. Commit Your Changes

Write clear and descriptive commit messages. A good commit message explains what was changed and why.

git add .
git commit -m "feat: Add new amazing feature" # or "fix: Resolve bug in X"

7. Push to Your Fork 

git push origin feature/your-feature-name

8. Create a Pull Request

  • Go to the original AbdulElahGwaith/Mini-Agent repository on GitHub.
  • You should see a prompt to create a pull request from your new branch.
  • Provide a detailed description of your changes in the pull request template.
  • Link to any relevant issues.

Code Style

We generally follow PEP 8 for Python code. Please use a linter like flake8 or black to ensure your code is formatted correctly.

Reporting Bugs

If you find a bug, please open an issue on GitHub. Provide as much detail as possible, including:

  • A clear and concise description of the bug.
  • Steps to reproduce the behavior.
  • Expected behavior.
  • Screenshots or error messages if applicable.

Feature Requests

We welcome ideas for new features! Please open an issue to discuss your ideas before starting work on them.

Thank you for contributing to Mini-Agent!