AI Portable Kit Developer Guide
Welcome to the official documentation repository for the AI Portable Kit Developer Guide! Our goal is to provide comprehensive and easy-to-understand guides to help users program and control the AI Portable Kit using the Python programming language and development environment.
Getting Started
Before you begin, please ensure you are familiar with basic Git operations and Markdown syntax. This will help you contribute and retrieve information more efficiently.
Documentation Redirect Links
Reporting Issues
If you encounter any issues while using the guide or developing with myAGV, please follow these steps:
- Visit the Issues page.
- Click the "New Issue" button to create a new issue.
- Provide as much detail as possible, including but not limited to:
- Description of the issue.
- Steps to reproduce.
- Expected vs. actual results.
- Screenshots or code snippets.
- After submitting, please wait patiently for a response from our team.
How to submit a merge request
We warmly welcome and encourage community members to improve the documentation or add new content. If you would like to contribute, please follow these steps:
- Fork this repository to your GitHub account.
- Clone the forked repository to your local computer.
- Create a new branch for your changes.
- After making your changes, commit them to your fork.
- On GitHub, submit a merge request (MR) to the
main
branch of the original repository. - In your MR description, clearly describe the changes you made and the rationale for them.
- After submitting your MR, please wait patiently for our team to review it.
Contribution Guidelines
Our goal is to maintain an open and welcoming environment where everyone feels comfortable contributing. Since we don't currently have a code of conduct, we ask that you remain professional and respectful in your interactions within the project.
Adding a Code of Conduct
We recommend adding a code of conduct to your project to foster a positive and inclusive environment. GitHub provides templates such as the Contributor Covenant, which is widely adopted by open source projects. You can create a CODE_OF_CONDUCT.md
in your repository and reference it here after adding it.
Support and Contact
If you need any help, have suggestions, or have feedback, please feel free to contact us.
Thank you for your support and contributions!