Skip to content

Latest commit

 

History

History
96 lines (57 loc) · 3.51 KB

CONTRIBUTING.md

File metadata and controls

96 lines (57 loc) · 3.51 KB
Raw

Contributing to AgenticAGI

Thank you for your interest in contributing to AgenticAGI! We welcome contributions from the community to help improve the project. Whether you're submitting a bug fix, new feature, or helping with documentation, your efforts are greatly appreciated.

How to Contribute

1. Fork the Repository

To start contributing, first fork the repository to your own GitHub account. This will allow you to freely make changes to the codebase without affecting the main project.

2. Clone the Repository

Clone your forked repository to your local machine:

git clone https://github.com/YOUR_USERNAME/agentic-agi.git

3. Create a New Branch

For every feature, bug fix, or change, create a new branch with a descriptive name:

git checkout -b feature/your-feature-name

4. Make Your Changes

Make your code or documentation changes. Be sure to write clear and concise code, following the existing code style wherever possible. Also, don't forget to add or update tests if needed.

5. Run Tests

Before submitting your changes, run the tests to ensure everything works as expected:

# Run tests (update with your test suite command if applicable)
python -m unittest discover

If you’ve added new features, please write corresponding tests to cover the changes.

6. Commit Your Changes

Commit your changes with a descriptive commit message. Follow this structure for your commits:

[Feature/Bugfix/Docs] Short description of your changes

Longer description if necessary. Explain what was changed and why, and reference any relevant issues or PRs.

Example:

git commit -m "[Feature] Add self-correction toggle to AgenticAGI CLI"

7. Push to Your Branch

Push your changes to your forked repository:

git push origin feature/your-feature-name

8. Submit a Pull Request

Go to the original repository and create a new pull request from your branch. In the pull request description, explain the changes you've made and reference any issues your pull request addresses.

9. Review Process

Your pull request will be reviewed by the project maintainers. You may be asked to make some revisions based on feedback. Once approved, your changes will be merged into the main branch.

Contribution Guidelines

To ensure the best quality contributions and a smooth process, please adhere to the following guidelines:

  • Code Quality: Ensure your code is clean, concise, and follows the existing code style.
  • Tests: If you're adding a new feature, make sure to write corresponding unit or integration tests.
  • Documentation: For every new feature, ensure that it is well-documented, including usage examples if necessary.
  • Commit Messages: Use meaningful and descriptive commit messages.
  • Issue Reporting: If you're reporting a bug, please include detailed steps to reproduce the issue, as well as your environment details.

Community Guidelines

We strive to create a welcoming and inclusive environment for all contributors. By participating in this project, you agree to adhere to our Code of Conduct. Please be respectful and considerate of others in all communications.

Getting Help

If you have any questions or need assistance, feel free to open an issue or reach out to the maintainers. We’re happy to help guide you through the contribution process.

Thank you for taking the time to contribute to AgenticAGI! 🙌

We look forward to your contributions.