diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..c3a525717 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,72 @@ + + +# Code of Conduct + +## Our Pledge + +We are committed to providing a friendly, safe, and welcoming environment for all, regardless of level of experience, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion. + +## Expected Behavior + +Examples of behavior that contributes to a positive environment for our community include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +## Unacceptable Behavior + +Examples of behavior that undermines our positive community environment include: + +- The use of sexualized language or imagery, and sexual attention or advances of any kind +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic address, phone number, or other information that might lead to harassment or privacy invasion +- Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +Community leaders represent the community in public interactions. We recognize that a community that excludes people in practice is not a welcoming community. Therefore, community leaders in this project are expected to model inclusion and encourage and welcome diversity. + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior with tactics that are appropriate to the situation and the people involved. Remember that our community governance documents are meant as a guide, not as a set of hard-fast rules. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the community leaders. All complaints will be reviewed and investigated. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining the consequences for any code of conduct violations: + +### Guideline Severity + +**Guideline Level 1 Violations:** Use of sexualized language or imagery in public spaces. Unwelcome comments regarding a person's lifestyle choices and practices. Harassing or exclusionary jokes, and language used in public spaces. + +**Guideline Level 2 Violations:** Sending unsolicited sexual images (including GIFs) and persistent harassment. Follow-up communication after requests to stop. Public or private publication of others' private information. Inappropriate behavior that you know about, but choose not to report. Behavior that violates community standards outside events. + +**Guideline Level 3 Violations:** Belittling or demeaning posts that do not use sexualized language but diminish or insult an individual or a community of people. Advocating for, or encouraging, an individual or a community of people to be treated differently or with less privilege than others. Repeated violation of the same or similar guideline. + +**Guideline Level 4 Violations:** Creating a hostile environment for any reason (including but not limited to behavior listed above). + +### Enforcement Responses + +**Level 1 Violations:** First offense - verbal warning in public. Second offense - written warning in private. Third offense - 30-day community-wide mutual warning. + +**Level 2 Violations:** First offense - immediate warning in private. Second offense - temporary ban that includes a 1-year mutual warning. Third offense - permanent ban. + +**Level 3 Violations:** First offense - immediate warning in private. Second offense - temporary ban that includes a 1-year mutual warning. Third offense - permanent ban. + +**Level 4 Violations:** First offense - immediate permanent ban. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html) + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..cba684543 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,88 @@ + +# Contributing to agent-browser + +First off, thank you for considering contributing to agent-browser! It's people like you that make this project so great. + +## How Can I Contribute? + +### Reporting Bugs + +If you find a bug, please: + +1. Check if the issue already exists in the [Issue Tracker](https://github.com/dextonai/agent-browser/issues) +2. If not, open a new issue with: + - A clear title describing the issue + - A detailed description of what happened and what you expected + - Steps to reproduce the issue + - Any relevant error messages or logs + - Your environment information (OS, Node.js version, etc.) + +### Suggesting Enhancements + +If you have an idea for a new feature or improvement: + +1. Check if there's already an open enhancement request for your idea +2. If not, open a new issue with: + - A clear title describing your enhancement + - A detailed explanation of why this enhancement would be useful + - Any relevant examples or mockups + +### Contributing Code + +1. **Fork the repository** on GitHub to start with your own copy +2. **Create a new branch** for your changes: + ```bash + git checkout -b feature/your-feature-name + ``` +3. **Make your changes** and commit them with descriptive messages: + ```bash + git commit -m "feat: add your feature description" + ``` +4. **Push your changes** to your fork: + ```bash + git push origin feature/your-feature-name + ``` +5. **Open a Pull Request** against the `main` branch of the original repository + +### Code of Conduct + +Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. + +### Additional Resources + +- [GitHub Documentation](https://docs.github.com/en/free-pro-team/) on using GitHub +- [GitHub Community Forum](https://github.com/talk) for questions about using GitHub + +## Development Setup + +1. Clone the repository: + ```bash + git clone https://github.com/dextonai/agent-browser.git + cd agent-browser + ``` + +2. Install dependencies: + ```bash + pnpm install + ``` + +3. Build the project: + ```bash + pnpm build + ``` + +4. Run tests (if applicable): + ```bash + pnpm test + ``` + +## Style Guide + +- Follow the existing code style in the project +- Write clear, concise commit messages +- Add tests for new functionality +- Keep your changes focused and scoped + +## Questions? + +If you have any questions about contributing, please open an issue or contact the maintainers directly. diff --git a/README.md b/README.md index 8ede376c9..cc993a9de 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # agent-browser +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) + Browser automation CLI for AI agents. Fast native Rust CLI. ## Installation