Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (42 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

59 lines (42 loc) · 1.73 KB
Raw

🌟 Contributing to GitHub Streak Card

Thank you for your interest in contributing to GitHub Streak Card! We welcome all kinds of contributions — whether it's a bug fix, new feature, documentation improvement, or anything else that can make this project better.

🛠️ Getting Started

  1. Fork the Repository

    • Click on the “Fork” button at the top right corner.
    • Clone your forked version: 
      git clone https://github.com/your-username/GitHub-Streak-Card.git
cd GitHub-Streak-Card

  2. Install Dependencies

    • Make sure you have Node.js or any required tools installed.
    • Install project dependencies: 
      npm install

  3. Create a Branch

    • Use descriptive naming: 
      git checkout -b fix-issue-#12

✍️ How to Contribute

  • 🔍 Report Bugs: Open an issue with detailed reproduction steps.
  • 💡 Suggest Features: Propose enhancements by describing your idea in detail.
  • 🧰 Code Contributions:
    • Follow the project's existing coding style.
    • Write clean, self-documenting code with helpful comments.
    • Test your changes before submitting.

✅ Pull Request Guidelines

  1. Make sure your code works.
  2. Keep PRs small and focused.
  3. Reference related issue(s) in the PR description.
  4. Submit your PR to the main branch.
  5. Include before/after screenshots or preview if applicable.

💬 Need Help?

Feel free to open a discussion or contact the maintainer if you need support.

Thank you for making GitHub better with your contributions! 🚀