Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (50 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

68 lines (50 loc) · 2.44 KB

Contributing to Agent Commerce Kit

We welcome contributions to Agent Commerce Kit! Here are a few ways you can help:

Reporting Bugs

If you encounter a bug, please help us by reporting it. To report a bug, please open an issue on our GitHub repository.

When filing a bug report, please include the following:

  • A clear and descriptive title.
  • Steps to reproduce the bug.
  • What you expected to happen.
  • What actually happened.
  • Your environment details (e.g., OS, Node.js version, Agent Commerce Kit version).

Suggesting Enhancements

We are always looking for ways to improve Agent Commerce Kit. If you have an idea for an enhancement, please open an issue on our GitHub repository. You can also reach us in our Discord.

When suggesting an enhancement, please include:

  • A clear and descriptive title.
  • A detailed description of the proposed enhancement.
  • Why this enhancement would be useful.
  • Any potential drawbacks or considerations.

AI Usage

The most important rule: you must understand your code. If you can't explain what your changes do and how they interact with the greater system without the aid of AI tools, please do not contribute to this project.

Using AI to write code is fine. This project has specific rules for AI usage. Please see the AI Usage Policy.

Code Contributions

We welcome code contributions! If you would like to contribute code, please follow these steps:

  1. Fork the repository: Create your own fork of the Agent Commerce Kit repository.
  2. Create a branch: Create a new branch in your fork for your changes (e.g., git checkout -b feature/your-feature-name or git checkout -b bugfix/issue-number).
  3. Make your changes: Implement your feature or bug fix.
  4. Commit your changes: Commit your changes with a clear and descriptive commit message.
  5. Push to your branch: Push your changes to your branch in your fork (e.g., git push origin feature/your-feature-name).
  6. Open a Pull Request (PR): Open a pull request from your branch to the main branch of the Agent Commerce Kit repository.
    • Ensure your PR description clearly describes the changes and links to any relevant issues.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Thank you for contributing to Agent Commerce Kit!