Open Ad Blocker

Commands

• npm run build:dev:chrome: built for development with source maps for Chrome browser.
• npm run build:prod:chrome: built for production for Chrome browser.
• npm run build:dev:edge: built for development with source maps for Edge browser.
• npm run build:prod:edge: built for production for edge browser.
• npm run lint: run linter to check code style.
• npm run lint:fix: run linter and automatically fix issues.
• npm run sync-rules: syncs the rules from the specified source.
• npm run test: run tests
• npm run server: rus local server. Can be used as dev environment (Config endpoint). In case you need to use a SPECIFIC port, add PORT variable before running a command.

Contributing

We welcome contributions from the community! Please follow these guidelines to ensure a smooth collaboration process.

Pull Request Guidelines

1. Fork the Repository: Start by forking the repository to your GitHub account.
2. Create a Branch: Create a new branch for your feature or bug fix. Use a descriptive name, e.g., fix-broken-filter or add-custom-rules.
3. Write Clear Commit Messages: Ensure your commit messages are concise and descriptive. Use the format: Example: fix: resolve issue with adblocker filter not loading.
4. Follow Code Standards: Adhere to the project's coding standards and style guidelines.
5. Test Your Changes: Verify that your changes work as expected and do not introduce new issues.
6. Submit a Pull Request: Open a pull request to the main branch. Include the following in the description:
   • Summary: Briefly describe the changes made.
   • Issue Reference: Link to the related issue (if applicable).
   • Testing: Explain how you tested the changes.
   • Screenshots: Provide screenshots or videos if the changes affect the UI.

Issue Reporting Guidelines

1. Search Before Posting: Check if the issue has already been reported to avoid duplicates.
2. Use a Clear Title: Write a concise and descriptive title for the issue.
3. Provide Detailed Information: Include the following in the issue description:
   • Steps to Reproduce: Provide step-by-step instructions to reproduce the issue.
   • Expected Behavior: Describe what you expected to happen.
   • Actual Behavior: Explain what actually happened.
   • Environment: Specify the browser, version, and operating system you are using.
   • Screenshots/Logs: Attach screenshots or logs to help diagnose the issue.
4. Label Appropriately: Use appropriate labels (e.g., bug, enhancement, question) to categorize the issue.

By following these guidelines, you help us maintain a high-quality codebase and streamline the development process. Thank you for contributing!