Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 3.16 KB

CONTRIBUTING.md

File metadata and controls

66 lines (43 loc) · 3.16 KB

Contributing to Profile Card Generator

Welcome to the Profile Card Generator! We're excited to have you as a contributor. This document will guide you through the process of contributing to our project, whether it's reporting bugs, suggesting enhancements, or submitting code changes.

Table of Contents

💡 How Can You Contribute?

There are many ways you can contribute to AdBlocker:

  • Main contribution you can do by adding your own profile card style
  • Adding more interactive UI
  • Report bugs or suggest improvements by opening issues.
  • Contribute code changes by forking the repository and creating pull requests.
  • Help with documentation improvements.

🐞 Reporting Bugs

If you find a bug in the extension, please follow these steps:

  1. Check the issue tracker to see if the bug has already been reported.
  2. If not, open a new issue and provide as much detail as possible, including steps to reproduce the issue and information about your environment.

🌟 Suggesting Enhancements

We welcome suggestions for new features or improvements to the extension. To suggest an enhancement:

  1. Check the issue tracker to ensure it hasn't already been suggested.
  2. If it's a new suggestion, open a new issue, and describe your idea, its use case, and why it would be valuable.

🛠️ Contributing Code

If you'd like to contribute code to Profile Card Generator, follow these steps:

  1. Fork the repository to your own GitHub account.
  2. Create a new branch from the main branch with a descriptive name, e.g., feature/new-feature or bugfix/fix-issue.
  3. Make your changes, following best practices and coding standards.
  4. Test your changes thoroughly to ensure they don't introduce new issues.
  5. Create a pull request (PR) to the main branch of the main repository.
  6. Ensure your PR includes a clear description of the changes and the problem it solves.
  7. Our team will review your PR and provide feedback. Be prepared to make necessary adjustments.

📖 Documentation

Improvements to documentation are always welcome. If you spot a mistake or want to enhance our documentation, please submit a PR with your changes.

💬 Discussions

If you have ideas, questions, or want to discuss anything related to the extension, feel free to start discussion at Discord

🧐 Code of Conduct

Please note that we have a Code of Conduct that all contributors and community members are expected to follow. Please be respectful and considerate when interacting with others in this project.

🎉 Thank You!

We appreciate your interest in contributing to AdBlocker. Your contributions help make this project better for everyone. Let's build something great together! 🚀