-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
58 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
|
||
# Contributing to AI-Browser-Automation | ||
|
||
First of all, thanks for taking the time to contribute! 🎉 | ||
|
||
## How to Contribute | ||
|
||
1. **Fork the Repository**: | ||
- Click the "Fork" button in the top-right corner of this repository. | ||
- Clone your forked repository: | ||
```bash | ||
git clone https://github.com/your-username/ai-browser-automation.git | ||
``` | ||
|
||
2. **Create a Branch**: | ||
- Work on a feature branch to keep changes clean: | ||
```bash | ||
git checkout -b feature/your-feature-name | ||
``` | ||
|
||
3. **Commit Your Changes**: | ||
- Follow conventional commits format for clarity. | ||
```bash | ||
git commit -m "feat: add your feature description" | ||
``` | ||
|
||
4. **Push Changes**: | ||
- Push your branch to your forked repository: | ||
```bash | ||
git push origin feature/your-feature-name | ||
``` | ||
|
||
5. **Create a Pull Request**: | ||
- Go to the original repository. | ||
- Click on "Pull Requests" > "New Pull Request". | ||
- Select your branch and submit the PR. | ||
|
||
## Contribution Guidelines | ||
|
||
- **Bug Reports**: | ||
- Create an issue describing the bug. | ||
- Include clear steps to reproduce. | ||
|
||
- **Feature Requests**: | ||
- Suggest features by opening an issue. | ||
- Describe why the feature is valuable. | ||
|
||
- **Code Style**: | ||
- Follow the existing code style in the project. | ||
- Run linters and formatters before submitting code. | ||
|
||
## Reporting a Vulnerability | ||
|
||
If you find a security vulnerability, please do not open a public issue. Instead, report it via the **SECURITY.md** guidelines. | ||
|
||
--- | ||
|
||
Thank you for helping to improve AI-Browser-Automation! 🚀 |