Thank you for your interest in contributing to My AdsBlock Extention [SteamGuard]! This document provides guidelines and instructions for contributing to this project.
By participating in this project, you agree to maintain a respectful and inclusive environment for everyone.
If you find a bug, please create an issue with the following information:
- A clear, descriptive title
- Steps to reproduce the issue
- Expected behavior
- Actual behavior
- Screenshots (if applicable)
- Browser version and operating system
We welcome suggestions for improvements! When suggesting an enhancement:
- Use a clear, descriptive title
- Provide a detailed description of the proposed enhancement
- Explain why this enhancement would be useful
- Include any relevant examples or mockups
- Fork the repository
- Create a new branch for your feature or bug fix
- Make your changes
- Test your changes thoroughly
- Submit a pull request with a clear description of the changes
To set up your development environment: [comming soon]
- Clone the repository
- Open Chrome and navigate to
chrome://extensions/ - Enable "Developer mode"
- Click "Load unpacked" and select the extension directory
- Make changes to the code
- Reload the extension to test changes
- Use clear, descriptive variable and function names
- Add comments for complex logic
- Follow ES6+ standards when possible
- Format your code consistently
- Keep the modular structure of the project
- Place new content scripts in the
content-scriptsdirectory - Add rules to
rules/ad-domains.jsonfor new ad domains
Before submitting your changes:
- Test on multiple websites
- Verify that existing functionality still works
- Ensure your code doesn't break the extension
- Check that the extension still avoids detection
Once you submit a pull request:
- Maintainers will review your code
- They may suggest changes or improvements
- Once approved, your changes will be merged
Thank you for contributing to StreamGuard!