diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..b694130a9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +# Contributing to agent-browser + +Thank you for your interest in improving `agent-browser`! We welcome contributions from everyone. + +## Getting Started + +1. **Fork the repository**: Create your own copy of the project. +2. **Clone your fork**: + ```bash + git clone https://github.com/YOUR_USERNAME/agent-browser.git + ``` +3. **Install dependencies**: + Follow the instructions in the `README.md` to set up your development environment. + +## Contribution Process + +1. **Create a Branch**: Always create a new branch for your changes: + ```bash + git checkout -b feat/your-feature-name + ``` +2. **Make Changes**: Ensure your code follows the project's style guidelines. +3. **Test Your Changes**: Run existing tests and add new ones if applicable. +4. **Submit a Pull Request**: + - Provide a clear and descriptive title. + - Describe your changes and why they are necessary. + - Link the PR to an existing issue if applicable. + +## Coding Standards + +- Use clear and descriptive variable and function names. +- Follow the established project structure. +- Ensure all new features are documented in the `README.md` or relevant docs. + +## Communication + +If you have questions or want to discuss a feature, please open an issue or reach out to the maintainers. + +Happy coding! 🚀 \ No newline at end of file