Skip to content

Contributing Guide

Jump to bottom
Kourosh edited this page Feb 26, 2026 · 1 revision

🤝 Contributing to GitHub Profile Analyzer

First off, thank you for considering contributing to the GitHub Profile Analyzer! It's people like you that make this tool great. We welcome contributions of all kinds, from fixing typos to suggesting new features.

This guide will help you get started. Please note we have a CODE_OF_CONDUCT.md that all contributors are expected to adhere to.

🐛 Reporting Bugs

  • Before creating a bug report, please check the Issues to see if the problem has already been reported.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a clear title and description, as much relevant information as possible (e.g., browser, Python version), and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

💡 Suggesting Enhancements

  • Open a new issue with a clear title and detailed description.
  • Explain why this enhancement would be useful to most users.
  • You can also start a discussion in the Discussions tab to get feedback on your idea first.

🧑‍💻 Your First Code Contribution

  1. Fork the repository to your own GitHub account.
  2. Clone the forked repository to your local machine. 
    git clone https://github.com/your-username/Github-Profile-Analyser.git
  3. Create a new branch for your changes. This keeps your work organized and separate from the main code. 
    git checkout -b feature/your-amazing-feature-name
  4. Make your changes. Please follow the coding style of the project (e.g., PEP 8 for Python) [cite: your own README].
  5. Test your changes locally to ensure they work and don't break existing functionality.
  6. Commit your changes with a clear and concise commit message. 
    git commit -m 'Add a new metric for repository topics'
  7. Push your branch to your fork on GitHub. 
    git push origin feature/your-amazing-feature-name
  8. Open a Pull Request from your branch to the main branch of the original repository. Provide a clear description of the changes you've made.

Thank you for helping improve the GitHub Profile Analyzer!

Clone this wiki locally